Setup mkdocs-materials

[gh-repo-status-check]

How can I switch from urls like docs.example.com/setup/docker.html to docs.example.com/setup/docker. How does that work?

[niclasheinz]

Can you please add some context to the setup? For example, which plugins are activated?

[gh-repo-status-check]

I use the following plugins:

• privacy
• offline
• search
• git-revision-date-localized
• minify
• social
• tags
• mkdocs-gallery
• print-site

[kamilkrzyskow]

Hello @gh-repo-status-check,
the way links are processed is related to the use_directory_urls config option. MkDocs generates static HTML pages, and it's either .../docker.html or .../docker/index.html, where the latter can be opened with .../docker/. Notice the / at the end which "opens" the directory, and the web browser automatically loads the index.html file.

There is no official way to setup direct link to docker.html pages without the .html part. You could theoretically modify the links with a hook, however some plugins could rely on the .html suffix for processing, so I wouldn't personally try to hack it. Therefore my recommendation is to enable the directory urls (which is the default), and use the links with the trailing slash.

Similar discussions:

• Configure no trailing slash in URLs? #6332
• How to remove .html extension from page urls (gh-pages)? #6046
• I recall there was one more, which I had in mind, but can't find it either here or in the other discussion board 🤔

[gh-repo-status-check]

Thanks for your reply @kamilkrzyskow this setting is enabled, but I have still these .html urls

[kamilkrzyskow]

Then please create a minimal runnable reproduction archive, following this guide, which will help to pinpoint the issue, to either a plugin / misconfiguration.

Perhaps a plugin like, the offline plugin disables the directory links during the processing, as stated in #6046 it should be used only for local copy generation, not remote server.

mkdocs-material/material/plugins/offline/plugin.py

Line 41 in 7fb3a39

config.use_directory_urls = False

Make use of the !ENV syntax to conditionally enable such plugins only when needed:

• https://squidfunk.github.io/mkdocs-material/plugins/offline/#config.enabled

[gh-repo-status-check]

thanks for your time @kamilkrzyskow it works now.

[niclasheinz]

I have created a PR #7796 so that users can easily see this restriction in the official documentation