theanurin/mkdocs repository overview

⁠MkDocs

MkDocs⁠ 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.

⁠Image reason

The image embedding fixed version of MkDocs to prevent breaking changes in MkDocs and it's dependencies. Our team has repeatedly encountered problems regards to breaking changes in MkDocs dependencies.

⁠Spec

⁠Environment variables

• PYTHONPATH - Set path for additional Python's packages. Default /data/site-packages. (You may develop own extensions along with your site sources)

⁠Expose ports

• tcp/8000 - MkDocs' development server listening endpoint

⁠Volumes

• /data - Sources root (bind/mount here your work directory)

⁠Inside

• mkdocs==1.6.1
• mkdocs-material==9.6.19
• mkdocs-markdownextradata-plugin==0.2.6
• mkdocs-pdf-export-plugin==0.5.10
• fontawesome-in-markdown==0.2.1

⁠Launch

1. Start development server in documentation root directory (where mkdocs.yml located)

   docker run --interactive --tty --rm --volume ${PWD}:/data --publish 8000:8000 theanurin/mkdocs
   

   Copy
2. Open browser http://127.0.0.1:8000/⁠
3. Edit content and look for hot-reloaded changes in the browser

⁠Support

• Maintained by: Max Anurin⁠
• Where to get help: Telegram⁠