diff --git a/.github/workflows/deploy-mkdocs-preview.yaml b/.github/workflows/deploy-mkdocs-preview.yaml index 9f86c26a..74275793 100644 --- a/.github/workflows/deploy-mkdocs-preview.yaml +++ b/.github/workflows/deploy-mkdocs-preview.yaml @@ -84,7 +84,6 @@ jobs: ruby .scripts/merge-sitemaps.rb mkdir _site/2.x cp -R .submodules/wiremock.org-2.x/tmp/site_2x/* _site/2.x/ - rm _site-docs/index.html cp -R _site-docs/* _site/docs/ mkdir -p _site/3.x/docs cp -R _site-docs/* _site/3.x/docs/ diff --git a/_docs/index.html b/_docs/README.md similarity index 72% rename from _docs/index.html rename to _docs/README.md index a9548089..e391bc9d 100644 --- a/_docs/index.html +++ b/_docs/README.md @@ -6,61 +6,20 @@ Additionally, stubs can be configured via JSON files. Read the full doc here. --- - -

- WireMock is a popular open-source tool for API mock testing, with over 5 - million downloads per month. It can help you to create stable test and - development environments, isolate yourself from flakey 3rd parties and - simulate APIs that don't exist yet. -

- - -

Getting Started

+## Getting Started
@@ -83,14 +42,11 @@

Getting Started

-

Distributions

+## Distributions -

- WireMock provides the following generic distributions that allow running it as - a - standalone server - in a container or within a Java Virtual Machine. -

+WireMock provides the following generic distributions that allow running it as a +[standalone server](./standalone.md) +in a container or within a Java Virtual Machine.
@@ -121,12 +77,10 @@

Distributions

-

By use-case

+## By use-case -

- Below you can find links to the documentation for WireMock key use-cases. You - can find more documentation pages on the sidebar. -

+Below you can find links to the documentation for WireMock key use-cases. +You can find more documentation pages on the sidebar.
@@ -167,7 +121,7 @@

By use-case

@@ -187,13 +141,11 @@

By use-case

-

By protocol

+## By protocol -

- WireMock can serve all HTTP-based protocols and REST API. Through built-in - features and extensions, it provides additional capabilities for widely used - protocols. -

+WireMock can serve all HTTP-based protocols and REST API. +Through built-in features and extensions, +it provides additional capabilities for widely used protocols.
@@ -214,12 +166,10 @@

By protocol

-

By technology

+## By technology -

- There are also solutions and guides for particular technologies and - frameworks, provided by the WireMock community and external contributors. -

+There are also solutions and guides for particular technologies and frameworks, +provided by the WireMock community and external contributors.
diff --git a/_docs/resources/external.md b/_docs/resources/external.md index 0bc59495..956e2935 100644 --- a/_docs/resources/external.md +++ b/_docs/resources/external.md @@ -38,7 +38,7 @@ Listing of WireMock Extensions is now available on the documentation site ## Other languages -Most of the language integrations are linked from the [Documentation Root](../index.html). +Most of the language integrations are linked from the [Documentation Root](../README.md). Below there are some technologies that are yet to be added. PHP client by Rowan Hill: diff --git a/_docs/solutions/README.md b/_docs/solutions/README.md index 77454dc4..3bff898b 100644 --- a/_docs/solutions/README.md +++ b/_docs/solutions/README.md @@ -1,3 +1,5 @@ # WireMock Solutions -See the [documentation landing](../index.html) +There are also solutions and guides for particular technologies and frameworks, provided by the WireMock community and external contributors. + +See the [documentation landing](../README.md) diff --git a/docs.html b/docs.html deleted file mode 100644 index 8b588142..00000000 --- a/docs.html +++ /dev/null @@ -1,318 +0,0 @@ ---- -title: "WireMock User Documentation" -meta_title: "WireMock User Documentation | WireMock" -crumbtitle: "Documentation" -toc_rank: 1001 -permalink: /docs/ -docs-wide: true -description: > - All of WireMock’s features are accessible via its REST (JSON) interface and its Java API. - Additionally, stubs can be configured via JSON files. Read the full doc here. ---- - - - -

- WireMock is a popular open-source tool for API mock testing, with over 5 - million downloads per month. It can help you to create stable test and - development environments, isolate yourself from flakey 3rd parties and - simulate APIs that don't exist yet. -

- - -

Getting Started

- -
- - - Overview - - - - Quick Start - - - - Download - - - - Get Help - -
- -

Distributions

- -

- WireMock provides the following generic distributions that allow running it as - a - standalone server - in a container or within a Java Virtual Machine. -

- -
- - - Standalone JAR - - - - Docker - - - - Helm (Experimental) - - - - WireMock Cloud (commercial SaaS) - - - - NPM - -
- -

By use-case

- -

- Below you can find links to the documentation for WireMock key use-cases. You - can find more documentation pages on the sidebar. -

- -
- - Wiremock Features - Advanced request matching - - - wiremock dynamic response - Dynamic response templating - - - - wiremock unit tests - Use API Mocking in your unit tests - - - wiremock fault and latency - Fault and latency injection - - - wiremock record playback - Record / Playback - - - - WireMock API Templates - Use pre-defined Mock API templates - - - Extending WireMock - Extending WireMock - -
- -

By protocol

- -

- WireMock can serve all HTTP-based protocols and REST API. Through built-in - features and extensions, it provides additional capabilities for widely used - protocols. -

- -
- - - Webhooks and Callbacks - - - - HTTPs - - - - gRPC - - - - GraphQL - -
- -

By technology

- -

- There are also solutions and guides for particular technologies and - frameworks, provided by the WireMock community and external contributors. -

- -
- - - Java and JVM - - - - Python - - - - Spring Boot - - - - Node.js - - - - Android - - - - .NET - - - - Golang - - - - Rust - - - - Groovy - - - - Kotlin - - - - Kubernetes - - - - Testcontainers - - - - Quarkus - - - - C/C++ - -
diff --git a/extra_sass/_docs_root.scss b/extra_sass/_docs_root.scss new file mode 100644 index 00000000..a161abf2 --- /dev/null +++ b/extra_sass/_docs_root.scss @@ -0,0 +1,36 @@ +.grid-container { + display: grid; + margin-left: auto; + margin-right: auto; + margin-bottom: 2rem; + max-width: 160rem; + gap: 1rem; + grid-template-columns: repeat(auto-fill, 14rem); + vertical-align: middle; +} + +.grid-container .card { + display: flex; + border: 0.2rem solid; + border-radius: 1rem; + height: 6rem; + width: 14rem; + font-size: large; + font-weight: 600; + vertical-align: middle; + align-items: center; +} + +.grid-container .card-use-case { + font-size: large; +} + +.grid-container .card > img { + width: 4rem; + height: auto; + border-style: none; + margin-top: 10px; + margin-bottom: 10px; + margin-right: 10px; + margin-left: 10px; +} diff --git a/extra_sass/style.css.scss b/extra_sass/style.css.scss index a05debde..4839fcd9 100644 --- a/extra_sass/style.css.scss +++ b/extra_sass/style.css.scss @@ -2,4 +2,5 @@ @import "_variables"; @import "_masthead"; +@import "_docs_root"; @import "_buttons"; diff --git a/mkdocs.yml b/mkdocs.yml index ec9af986..000176e3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -164,6 +164,7 @@ plugins: 'solutions/docker.md': 'standalone/docker.md' 'running-standalone.md': 'standalone/java-jar.md' 'support.md': '../support' + 'solutions.md': "README.md" nav: - Using WireMock: