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 .

    Please make sure you have the following requirements installed:

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

    Your local documentation server will run by default on http://127.0.0.1:8000.

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

    1. ...

    Please make sure you have the following requirements installed:

    Then, install MkDocs with pip.

    1. pip install --user -r requirements.txt

    To check that the documentation meets standard expectations (no dead links, html markup validity, …), use the docs-verify target.

    1. $ make docs-verify
    2. docker build -t traefik-docs-verify ./script/docs-verify-docker-image ## Build Validator image
    4. === Checking HTML content...
    5. 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 safer to clean it before verifying it.

    Will perform all necessary steps for you.

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

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