minidocks/mkdocs

MkDocs docker image (https://hub.docker.com/r/minidocks/mkdocs)

https://www.mkdocs.org/ is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

Installed extensions

Themes

• https://squidfunk.github.io/mkdocs-material/ usings Google’s Material Design guidelines.
• Alabaster theme is a visually (c)lean, responsive, configurable theme.
• https://kpn.github.io/mkdocs-kpn-theme/

Plugins

• https://github.com/sander76/mkdocs-abs-rel-plugin
• https://github.com/ignorantshr/mkdocs-add-number-plugin plugin to automatically number the headings (h1-h6) in each markdown page and the nav.
• https://github.com/midnightprioriem/mkdocs-autolinks-plugin/ simplifies relative linking between documents.
• https://github.com/mkdocstrings/autorefs automatically link across pages.
• https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin allows you to customize how your pages show up the navigation of your MkDocs without having to configure the full structure in your mkdocs.yml.
• https://github.com/apenwarr/mkdocs-exclude allows you to exclude files from your input using unix-style wildcards (globs) or regular expressions (regexes).
• https://github.com/EddyLuten/mkdocs-categories-plugin allows for multiple categories per page and will generate a category index page
• https://smarie.github.io/mkdocs-gallery/
• https://oprypin.github.io/mkdocs-gen-files/ programmatically generates documentation pages during the build.
• https://github.com/timvink/mkdocs-git-authors-plugin
• https://github.com/ojacques/mkdocs-git-committers-plugin-2
• https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
• https://github.com/ovasquez/mkdocs-merge allows you to merge the source of multiple MkDocs sites into a single one converting each of the specified sites to a sub-site of the master site.
• https://github.com/timvink/mkdocs-enumerate-headings-plugin will enumerate the headings (h1-h6) across site pages.
• https://github.com/stuebersystems/mkdocs-img2fig-plugin converts <img> to <figure>.
• https://github.com/AVATEAM-IT-SYSTEMHAUS/mkdocs-kroki-plugin
• https://oprypin.github.io/mkdocs-literate-nav/ specifies the navigation in Markdown instead of YAML.
• https://github.com/fralau/mkdocs_macros_plugin transforms the markdown pages into jinja2 templates that use variables, calls to macros and custom filters.
• https://github.com/rosscdh/mkdocs-markdownextradata-plugin injects the mkdocs.yml extra variables into the markdown template.
• https://github.com/byrnereese/mkdocs-minify-plugin to minify HTML and/or JS files prior to being written to disk.
• https://mkdocstrings.github.io/ automatic documentation from sources.
• https://github.com/pawelsikora/mkdocs-with-confluence/ Plugin for uploading markdown documentation to Confluence via Confluence REST API
• https://github.com/spotify/mkdocs-monorepo-plugin Build multiple documentation in a single Mkdocs. Designed for large codebases.
• https://github.com/jdoiro3/mkdocs-multirepo-plugin Build documentation in multiple repos into one site.
• https://github.com/shu307/mkdocs-nav-weight enables to organize navigation in a more markdownic way
• Neoterot plugins
• https://github.com/leonardehrenfried/mkdocs-no-sitemap-plugin disables the generation of a sitemap in Mkdocs sites.
• https://timvink.github.io/mkdocs-print-site-plugin/index.html adds a page to your site combining all pages, allowing your site visitors to File > Print > Save as PDF the entire site.
• https://mkusz.github.io/mkdocs-publisher/
• https://github.com/facelessuser/mkdocs_pymdownx_material_extras
• https://github.com/raimon49/mkdocs-safe-text-plugin for safe text editing with MKDocs.
• https://oprypin.github.io/mkdocs-same-dir/ allows placing mkdocs.yml in the same directory as documentation.
• https://github.com/aklajnert/mkdocs-simple-hooks to define your own hooks for mkdocs, without having to create a new package.
• Simple enables you to build a documentation site from markdown interspersed within your repository using mkdocs.
• https://blueswen.github.io/mkdocs-swagger-ui-tag/
• https://github.com/datarobot/mkdocs-redirects to create page redirects (e.g. for moved/renamed pages).

Only in 1-pdf and pdf tags

• https://github.com/zhaoterryy/mkdocs-pdf-export-plugin will export all markdown pages in your project as PDF files using WeasyPrint. (only in pdf and 1-pdf tag)
• https://github.com/orzih/mkdocs-with-pdf will generate a single PDF file from MkDocs repository. (only in pdf and 1.0-pdf tag)

Markdown extension

• https://github.com/vokimon/markdown-customblocks settles a common markup for parametrizable and nestable components.
• https://github.com/cmacmackin/markdown-include/ allows the inclusion of the contents of other Markdown documents.
• Pygments is a generic syntax highlighter.
• https://facelessuser.github.io/pymdown-extensions/ is a collection of extensions for Python Markdown.
• https://github.com/radude/mdx_truly_sane_lists that makes lists truly sane. Features custom indents for nested lists and fix for messy linebreaks and paragraphs between lists.
• https://github.com/adamb70/mdx-breakless-lists Use lists without requiring a line break above them.

Usage

Create a new documentation project in doc directory:

bash
docker run --rm -v "`pwd`:/app" -w /app minidocks/mkdocs new doc

Start documentation server in doc directory on port 8000 with material design theme:

bash
docker run --rm -v "`pwd`:/app" -w /app/doc -p 8000:8000 minidocks/mkdocs serve -a 0.0.0.0:8000 -t material

Tags

Related images

• https://github.com/minidocks/sphinx-doc

Alternatives

• https://github.com/raspberryvalley/docker-mkdocs
• https://github.com/pozgo/docker-mkdocs
• https://github.com/squidfunk/mkdocs-material