add admonition config

wiremock · Jan 22, 2024 · 155dba0 · 155dba0
1 parent faeb2b3
commit 155dba0
Showing 1 changed file with 167 additions and 165 deletions.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -85,7 +85,7 @@ extra:
     provider: google
     # FIXME: Update when in Production
     property: G-QSLQ4RWTRP
-    
+
 plugins:
   - extra-sass
   - search
@@ -101,202 +101,204 @@ plugins:
       keep_docs_dir: true
       nav_repos:
         - name: graphql-extension
-          import_url: 'https://github.com/wiremock/wiremock-graphql-extension?branch=main&edit_uri=/blob/main/'
-          imports: [ /README.md, docs/* ]
+          import_url: "https://github.com/wiremock/wiremock-graphql-extension?branch=main&edit_uri=/blob/main/"
+          imports: [/README.md, docs/*]
         - name: grpc-extension
-          import_url: 'https://github.com/wiremock/wiremock-grpc-extension?branch=main&edit_uri=/blob/main/'
-          imports: [ /README.md, docs/* ]
+          import_url: "https://github.com/wiremock/wiremock-grpc-extension?branch=main&edit_uri=/blob/main/"
+          imports: [/README.md, docs/*]
         - name: state-extension
-          import_url: 'https://github.com/wiremock/wiremock-state-extension?branch=develop&edit_uri=/blob/develop/'
-          imports: [ /README.md, docs/*  ]
+          import_url: "https://github.com/wiremock/wiremock-state-extension?branch=develop&edit_uri=/blob/develop/"
+          imports: [/README.md, docs/*]
         - name: otel-extension
-          import_url: 'https://github.com/wiremock/wiremock-otel-extension?branch=main&edit_uri=/blob/main/'
-          imports: [ /README.md ]
+          import_url: "https://github.com/wiremock/wiremock-otel-extension?branch=main&edit_uri=/blob/main/"
+          imports: [/README.md]
         - name: faker-extension
-          import_url: 'https://github.com/wiremock/wiremock-faker-extension?branch=main&edit_uri=/blob/main/'
-          imports: [ /README.md ]
-          
+          import_url: "https://github.com/wiremock/wiremock-faker-extension?branch=main&edit_uri=/blob/main/"
+          imports: [/README.md]
+
         # Outside WireMock GitHub org
         - name: 9cookies-extension
-          import_url: 'https://github.com/9cookies/wiremock-extensions?branch=master&edit_uri=/blob/master/'
-          imports: [ /*.md ]
+          import_url: "https://github.com/9cookies/wiremock-extensions?branch=master&edit_uri=/blob/master/"
+          imports: [/*.md]
         - name: jwt-extension
-          import_url: 'https://github.com/MasonM/wiremock-jwt-extension?branch=master&edit_uri=/blob/master/'
-          imports: [ /README.md ]
+          import_url: "https://github.com/MasonM/wiremock-jwt-extension?branch=master&edit_uri=/blob/master/"
+          imports: [/README.md]
         - name: cors-extension
-          import_url: 'https://github.com/RichieLoco/WiremockCorsExtension?branch=master&edit_uri=/blob/master/'
-          imports: [ /README.md ]
+          import_url: "https://github.com/RichieLoco/WiremockCorsExtension?branch=master&edit_uri=/blob/master/"
+          imports: [/README.md]
         - name: stub-mapping-tracker-extension
-          import_url: 'https://github.com/MasonM/wiremock-stub-mapping-tracker?branch=master&edit_uri=/blob/master/'
-          imports: [ /README.md ]
+          import_url: "https://github.com/MasonM/wiremock-stub-mapping-tracker?branch=master&edit_uri=/blob/master/"
+          imports: [/README.md]
         - name: prometheus-extension
-          import_url: 'https://github.com/mikeskali/wiremock-metrics?branch=master&edit_uri=/blob/master/'
-          imports: [ /README.md ]
+          import_url: "https://github.com/mikeskali/wiremock-metrics?branch=master&edit_uri=/blob/master/"
+          imports: [/README.md]
         - name: record-delay-extension
-          import_url: 'https://github.com/anuragashok/wiremock-extension-record-delay?branch=main&edit_uri=/blob/main/'
-          imports: [ /README.md ]
+          import_url: "https://github.com/anuragashok/wiremock-extension-record-delay?branch=main&edit_uri=/blob/main/"
+          imports: [/README.md]
         - name: velocity-transformer-extension
-          import_url: 'https://github.com/adamyork/wiremock-velocity-transformer?branch=master&edit_uri=/blob/master/'
-          imports: [ /README.md ]
+          import_url: "https://github.com/adamyork/wiremock-velocity-transformer?branch=master&edit_uri=/blob/master/"
+          imports: [/README.md]
         - name: unused-stubs-extension
-          import_url: 'https://github.com/MasonM/wiremock-unused-stubs-extension?branch=master&edit_uri=/blob/master/'
-          imports: [ /README.md ]
+          import_url: "https://github.com/MasonM/wiremock-unused-stubs-extension?branch=master&edit_uri=/blob/master/"
+          imports: [/README.md]
         - name: metrics-extension
-          import_url: 'https://github.com/rasklaad/wiremock-metrics?branch=master&edit_uri=/blob/master/'
-          imports: [ /README.MD ]
+          import_url: "https://github.com/rasklaad/wiremock-metrics?branch=master&edit_uri=/blob/master/"
+          imports: [/README.MD]
 
         # System
         - name: community
-          import_url: 'https://github.com/wiremock/community?branch=main&edit_uri=/blob/main/'
-          imports: [ "*" ]
+          import_url: "https://github.com/wiremock/community?branch=main&edit_uri=/blob/main/"
+          imports: ["*"]
         - name: dotgithub
-          import_url: 'https://github.com/wiremock/.github?branch=main&edit_uri=/blob/main/'
-          imports: [ CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md ]
+          import_url: "https://github.com/wiremock/.github?branch=main&edit_uri=/blob/main/"
+          imports: [CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md]
   - redirects:
       redirect_maps:
-        'android.md': 'solutions/android.md'
-        'go.md': 'solutions/golang.md'
-        'solutions/go.md': 'solutions/golang.md'
-        'graphql.md': 'solutions/graphql.md'
-        'testcontainers.md': 'solutions/testcontainers.md'
-        'spring-boot.md': 'solutions/spring-boot.md'
-        'api.md': 'standalone/admin-api-reference.md'
-        'download.md': 'download-and-installation.md'
-        'tutorials.md': 'getting-started.md'
-        'plain-java.md': 'java-usage.md'
-        'junit-rule.md': 'junit-extensions.md'
-        'junit-4.md': 'junit-extensions.md'
-        'junit-5.md': 'junit-jupiter.md'
-        'docker.md': 'standalone/docker.md'
-        'solutions/docker.md': 'standalone/docker.md'
-        'running-standalone.md': 'standalone/java-jar.md'
-        'support.md': '../support'
-        'solutions.md': "README.md"
+        "android.md": "solutions/android.md"
+        "go.md": "solutions/golang.md"
+        "solutions/go.md": "solutions/golang.md"
+        "graphql.md": "solutions/graphql.md"
+        "testcontainers.md": "solutions/testcontainers.md"
+        "spring-boot.md": "solutions/spring-boot.md"
+        "api.md": "standalone/admin-api-reference.md"
+        "download.md": "download-and-installation.md"
+        "tutorials.md": "getting-started.md"
+        "plain-java.md": "java-usage.md"
+        "junit-rule.md": "junit-extensions.md"
+        "junit-4.md": "junit-extensions.md"
+        "junit-5.md": "junit-jupiter.md"
+        "docker.md": "standalone/docker.md"
+        "solutions/docker.md": "standalone/docker.md"
+        "running-standalone.md": "standalone/java-jar.md"
+        "support.md": "../support"
+        "solutions.md": "README.md"
 
 nav:
   - Using WireMock:
-    - Getting started:
-        - Overview: docs/overview.md
-        - "Quick Start: API Mocking with Java and JUnit 4": docs/quickstart/java-junit.md
-        - Download and Installation: docs/download-and-installation.md
-        - WireMock Tutorials: docs/getting-started.md
-        - FAQ: docs/faq.md
-    - WireMock Standalone:
-        - Running in Docker: docs/standalone/docker.md
-        - Running as a Standalone Process: docs/standalone/java-jar.md
-        - Administrating WireMock: docs/standalone/administration.md
-        - Admin REST API Specification: docs/standalone/admin-api-reference.md
-    - Java Usage:
-        - JUnit 5+ Jupiter: docs/junit-jupiter.md
-        - JUnit 4 and Vintage: docs/junit-extensions.md
-        - Spring Boot: docs/solutions/spring-boot.md
-        - Plain Java: docs/java-usage.md
-        - Java configuration: docs/configuration.md
-        - Running without the HTTP Server: docs/running-without-http-server.md
-    - Stubbing & Verifying:
-        - Stubbing: docs/stubbing.md
-        - Request Matching: docs/request-matching.md
-        - Response Templating: docs/response-templating.md
-        - Simulating Faults: docs/simulating-faults.md
-        - Stateful Behaviour: docs/stateful-behaviour.md
-        - Proxying: docs/proxying.md
-        - Verifying: docs/verifying.md
-    - Templating:
-        - WireMock API Templates Library: docs/mock-api-templates/README.md
-        - Using Mock API Templates: docs/mock-api-templates/usage.md
-    - Record & Playback:
-        - Record and Playback: docs/record-playback.md
-    - Protocols:
-        - Supported Protocols: docs/protocols/README.md
-        - Webhooks and Callbacks: docs/webhooks-and-callbacks.md
-        - Mocking gRPC services: docs/grpc.md
-        - WireMock and GraphQL: docs/solutions/graphql.md
-        - Serving HTTPs: docs/https.md
-    - Advanced use-cases:
-        - Multi-domain Mocking: docs/multi-domain-mocking.md
-        - Deploying into a servlet container: docs/advanced/deploy-to-servlet-container.md
-        - "WireMock on Java 1.7": docs/advanced/java7.md
-    - Reference:
-        - Admin API: docs/standalone/admin-api-reference.md
-        - Security: dotgithub/SECURITY.md
-        - WireMock API Templates Library: docs/mock-api-templates/README.md
-        
+      - Getting started:
+          - Overview: docs/overview.md
+          - "Quick Start: API Mocking with Java and JUnit 4": docs/quickstart/java-junit.md
+          - Download and Installation: docs/download-and-installation.md
+          - WireMock Tutorials: docs/getting-started.md
+          - FAQ: docs/faq.md
+      - WireMock Standalone:
+          - Running in Docker: docs/standalone/docker.md
+          - Running as a Standalone Process: docs/standalone/java-jar.md
+          - Administrating WireMock: docs/standalone/administration.md
+          - Admin REST API Specification: docs/standalone/admin-api-reference.md
+      - Java Usage:
+          - JUnit 5+ Jupiter: docs/junit-jupiter.md
+          - JUnit 4 and Vintage: docs/junit-extensions.md
+          - Spring Boot: docs/solutions/spring-boot.md
+          - Plain Java: docs/java-usage.md
+          - Java configuration: docs/configuration.md
+          - Running without the HTTP Server: docs/running-without-http-server.md
+      - Stubbing & Verifying:
+          - Stubbing: docs/stubbing.md
+          - Request Matching: docs/request-matching.md
+          - Response Templating: docs/response-templating.md
+          - Simulating Faults: docs/simulating-faults.md
+          - Stateful Behaviour: docs/stateful-behaviour.md
+          - Proxying: docs/proxying.md
+          - Verifying: docs/verifying.md
+      - Templating:
+          - WireMock API Templates Library: docs/mock-api-templates/README.md
+          - Using Mock API Templates: docs/mock-api-templates/usage.md
+      - Record & Playback:
+          - Record and Playback: docs/record-playback.md
+      - Protocols:
+          - Supported Protocols: docs/protocols/README.md
+          - Webhooks and Callbacks: docs/webhooks-and-callbacks.md
+          - Mocking gRPC services: docs/grpc.md
+          - WireMock and GraphQL: docs/solutions/graphql.md
+          - Serving HTTPs: docs/https.md
+      - Advanced use-cases:
+          - Multi-domain Mocking: docs/multi-domain-mocking.md
+          - Deploying into a servlet container: docs/advanced/deploy-to-servlet-container.md
+          - "WireMock on Java 1.7": docs/advanced/java7.md
+      - Reference:
+          - Admin API: docs/standalone/admin-api-reference.md
+          - Security: dotgithub/SECURITY.md
+          - WireMock API Templates Library: docs/mock-api-templates/README.md
+
   - Extensions:
-    - WireMock Extensions: docs/extensions/README.md
-    - Features:
-      - gRPC: grpc-extension/README.md
-      - GraphQL: graphql-extension/README.md
-      - State: state-extension/README.md
-      - Response Template Transformer: docs/response-templating.md
-      - Velocity Response Transformer: velocity-transformer-extension/README.md
-      - Data Faker: faker-extension/README.md
-      - Webhooks: webhooks-and-callbacks.md
-      - CORS protection: cors-extension/README.md
-      - JSON Web Tokens (JWT): jwt-extension/README.md
-      - JSON Body Transformer: 9cookies-extension/json-body-transformer.md
-      - Request Time Matcher: 9cookies-extension/request-time-matcher.md
-      - Unused Stubs: unused-stubs-extension/README.md
-    - Operations Extensions:
-      - Metrics Extension: metrics-extension/README.MD
-      - Prometheus Metrics: prometheus-extension/README.md
-      - OpenTelemetry: otel-extension/README.md
-    - Developer Extensions:
-      - Callback Simulator: 9cookies-extension/callback-simulator.md
-      - Keywords: 9cookies-extension/keywords.md
-      - Stub Mapping Tracker: stub-mapping-tracker-extension/README.md
-      - Record Delay Capture: record-delay-extension/README.md
+      - WireMock Extensions: docs/extensions/README.md
+      - Features:
+          - gRPC: grpc-extension/README.md
+          - GraphQL: graphql-extension/README.md
+          - State: state-extension/README.md
+          - Response Template Transformer: docs/response-templating.md
+          - Velocity Response Transformer: velocity-transformer-extension/README.md
+          - Data Faker: faker-extension/README.md
+          - Webhooks: webhooks-and-callbacks.md
+          - CORS protection: cors-extension/README.md
+          - JSON Web Tokens (JWT): jwt-extension/README.md
+          - JSON Body Transformer: 9cookies-extension/json-body-transformer.md
+          - Request Time Matcher: 9cookies-extension/request-time-matcher.md
+          - Unused Stubs: unused-stubs-extension/README.md
+      - Operations Extensions:
+          - Metrics Extension: metrics-extension/README.MD
+          - Prometheus Metrics: prometheus-extension/README.md
+          - OpenTelemetry: otel-extension/README.md
+      - Developer Extensions:
+          - Callback Simulator: 9cookies-extension/callback-simulator.md
+          - Keywords: 9cookies-extension/keywords.md
+          - Stub Mapping Tracker: stub-mapping-tracker-extension/README.md
+          - Record Delay Capture: record-delay-extension/README.md
 
   - Integrations:
-    - WireMock Solution Pages: docs/solutions/README.md
-    - Java and JVM Languages: docs/solutions/jvm.md
-    - gRPC: docs/grpc.md
-    - GraphQL: docs/solutions/graphql.md
-    - Python: docs/solutions/python.md
-    - Node.js: docs/solutions/nodejs.md
-    - .NET: docs/solutions/dotnet.md
-    - Golang: docs/solutions/golang.md
-    - Rust: docs/solutions/rust.md
-    - Kubernetes: docs/solutions/kubernetes.md
-    - Testcontainers: docs/solutions/testcontainers.md
-    - C/C++: docs/solutions/c_cpp.md
+      - WireMock Solution Pages: docs/solutions/README.md
+      - Java and JVM Languages: docs/solutions/jvm.md
+      - gRPC: docs/grpc.md
+      - GraphQL: docs/solutions/graphql.md
+      - Python: docs/solutions/python.md
+      - Node.js: docs/solutions/nodejs.md
+      - .NET: docs/solutions/dotnet.md
+      - Golang: docs/solutions/golang.md
+      - Rust: docs/solutions/rust.md
+      - Kubernetes: docs/solutions/kubernetes.md
+      - Testcontainers: docs/solutions/testcontainers.md
+      - C/C++: docs/solutions/c_cpp.md
 
   - Developer Guide:
-    - Extending WireMock: docs/extending-wiremock.md
-    - Filtering and Modifying Requests: docs/extensibility/filtering-requests.md
-    - Transforming Responses: docs/extensibility/transforming-responses.md
-    - Custom Matching: docs/extensibility/custom-matching.md
-    - Listening for Serve Events: docs/extensibility/listening-for-serve-events.md
-    - Admin API Extensions: docs/extensibility/extending-the-admin-api.md
-    - Adding Template Helpers: docs/extensibility/adding-template-helpers.md
-    - Adding Template Model Data: docs/extensibility/adding-template-model-data.md
-    - Listening for Stub Changes: docs/extensibility/listening-for-stub-changes.md
-    - Listening for Settings Changes: docs/extensibility/listening-for-settings-changes.md
-    - Mappings Loader Extensions: docs/extensibility/adding-mappings-loader.md
-    - Stub Metadata: docs/stub-metadata.md
-  
+      - Extending WireMock: docs/extending-wiremock.md
+      - Filtering and Modifying Requests: docs/extensibility/filtering-requests.md
+      - Transforming Responses: docs/extensibility/transforming-responses.md
+      - Custom Matching: docs/extensibility/custom-matching.md
+      - Listening for Serve Events: docs/extensibility/listening-for-serve-events.md
+      - Admin API Extensions: docs/extensibility/extending-the-admin-api.md
+      - Adding Template Helpers: docs/extensibility/adding-template-helpers.md
+      - Adding Template Model Data: docs/extensibility/adding-template-model-data.md
+      - Listening for Stub Changes: docs/extensibility/listening-for-stub-changes.md
+      - Listening for Settings Changes: docs/extensibility/listening-for-settings-changes.md
+      - Mappings Loader Extensions: docs/extensibility/adding-mappings-loader.md
+      - Stub Metadata: docs/stub-metadata.md
+
   - Community:
-    - Participate in WireMock: docs/participate.md
-    - Community Slack: community/slack.md
-    - Contributor Guide: community/contributing/README.md 
-    - Hacktoberfest 2023: dotgithub/CONTRIBUTING.md
-    - Creating Extensions: docs/extending-wiremock.md
-    - Governance: community/governance/README.md
-    - Code of Conduct: dotgithub/CODE_OF_CONDUCT.md
+      - Participate in WireMock: docs/participate.md
+      - Community Slack: community/slack.md
+      - Contributor Guide: community/contributing/README.md
+      - Hacktoberfest 2023: dotgithub/CONTRIBUTING.md
+      - Creating Extensions: docs/extending-wiremock.md
+      - Governance: community/governance/README.md
+      - Code of Conduct: dotgithub/CODE_OF_CONDUCT.md
 
   - Resources:
-    - Community Resources: resources/README.md
-    - Community Slack: community/slack.md
-    - Events:
-        Overview: community/events/README.md
-        Hacktoberfest: community/events/hacktoberfest/README.md
-        Archives: https://www.youtube.com/@WireMockChannel/playlists
-        Speaking: community/contributing/README.md#help-to-spread-the-word
-    - WireMock Support: dotgithub/SUPPORT.md
-    - Reporting Security Issues: dotgithub/SECURITY.md
-    - External Resources: resources/external.md
+      - Community Resources: resources/README.md
+      - Community Slack: community/slack.md
+      - Events:
+          Overview: community/events/README.md
+          Hacktoberfest: community/events/hacktoberfest/README.md
+          Archives: https://www.youtube.com/@WireMockChannel/playlists
+          Speaking: community/contributing/README.md#help-to-spread-the-word
+      - WireMock Support: dotgithub/SUPPORT.md
+      - Reporting Security Issues: dotgithub/SECURITY.md
+      - External Resources: resources/external.md
 
- # Markdown
+  # Markdown
 markdown_extensions:
+  - admonition
+  - pymdownx.details
   - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span
@@ -307,4 +309,4 @@ markdown_extensions:
   - pymdownx.tabbed:
       alternate_style: true
   - toc:
-      permalink: '#'
+      permalink: "#"