Feb 11, 2022 · I have an issue with MkDocs not being able to find my images. The images are in a subfolder, called microsatsFigures, in my docs folder. So my /docs folder contains index.md, …

Mar 10, 2016 · Can I somehow include a file into a file in mkdocs? I do not want to copy paste the same sections again and again. Thanks

I'm using mkdocs & mkdocstring to build my documentation and including code examples in the docstrings. I'm also using doctest (via pytest --doctest-modules) to test all those examples.

Feb 27, 2023 · FWIW, the current automatic-code-reference page suggests using the mkdocs-gen-files plugin and mkdocs-literate-nav with a bespoke script to generate md files with the ::: …

Dec 9, 2022 · Is there a possibility in MkDocs to "load" external packages? I use the mkdocstrings plugin to load the docstrings from my code. Its docs says, that the path must be set so that the …

Oct 26, 2022 · I am using mkdocs with the mkdocstrings plugin to generate the documentation of my Python package. My package is organized in a standard fashion - setup.py - mkdocs.yaml …

May 17, 2023 · project ├─mkdocs.yml ├─docs │ ├─home.md │ ├─chapter1.md │ ├─static ├─file.ext ├─image.png I am trying to find a way to "attach" file1.ext to the build, for instance …

Apr 30, 2022 · MkDocs is using Markdown, and therefore there are no available off-the-shelf variables you could use. So instead, you need to use something to preprocess your markdown …

Jun 11, 2020 · For a prepackaged solution to integrate mermaid diagrams into mkdocs, there is now the mkdocs-mermaid2 plugin, which I'm maintaining. For code highlighting, it also …

Jun 5, 2025 · I have a project using mkdocs-material where I have a bunch of documents and I want to generate a custom index page that contains a table listing specific meta data provided …