Documentation

You've found something unclear in the documentation and want to give a try at explaining it better? Let's see how.

This documentation is built with .

You can build the documentation and test it locally (with live reloading), using the target:

Default URL

If you only want to build the documentation without serving it locally, you can use the following command:

...

First, make sure you have python and pip installed.

Then, install mkdocs with pip.

To build the documentation locally and serve it locally, run mkdocs serve from the root directory. This will start a local server.

$ make docs-verify
docker build -t traefik-docs-verify ./script/docs-verify-docker-image ## Build Validator image
...
=== Checking HTML content...
Running ["HtmlCheck", "ImageCheck", "ScriptCheck", "LinkCheck"] on /app/site/basics/index.html on *.html...

Clean & Verify

If you've made changes to the documentation, it's safter to clean it before verifying it.

Disabling Documentation Verification

Verification can be disabled by setting the environment variable DOCS_VERIFY_SKIP to true:

DOCS_VERIFY_SKIP=true make docs-verify
DOCS_LINT_SKIP is true: no linting done.