Skip to content

davidivins/mkdocs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MkDocs docker image (minidocks/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.

Installed extensions

Themes

Plugins

  • Absolute to relative link
  • Add number plugin to automatically number the headings (h1-h6) in each markdown page and the nav.
  • Autolinks simplifies relative linking between documents.
  • 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.
  • Exclude allows you to exclude files from your input using unix-style wildcards (globs) or regular expressions (regexes).
  • Git authors
  • Git committers
  • Git revision date
  • Merge plugin 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.
  • Enumerate headings will enumerate the headings (h1-h6) across site pages.
  • Img2Fig converts <img> to <figure>.
  • Macros transforms the markdown pages into jinja2 templates that use variables, calls to macros and custom filters.
  • Markdown extra data injects the mkdocs.yml extra variables into the markdown template.
  • Minify to minify HTML and/or JS files prior to being written to disk.
  • Monorepo Build multiple documentation in a single Mkdocs. Designed for large codebases.
  • Pymdownx Material Extras
  • Safe text for safe text editing with MKDocs.
  • Simple hooks to define your own hooks for mkdocs, without having to create a new package.
  • Redirects to create page redirects (e.g. for moved/renamed pages).
  • Versioning
Only in 1-pdf and 1.1-pdf tags
  • PDF export will export all markdown pages in your project as PDF files using WeasyPrint. (only in 1.0-pdf tag)
  • PDF generate will generate a single PDF file from MkDocs repository. (only in 1.0-pdf tag)

Markdown extension

  • Include allows the inclusion of the contents of other Markdown documents.
  • Pygments is a generic syntax highlighter.
  • PyMdown Extensions is a collection of extensions for Python Markdown.

Usage

Create a new documentation project in doc directory:

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:

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

Tags

Tag Size
latest, 1
1
1-pdf

Related images

Alternatives

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Dockerfile 69.1%
  • Shell 30.9%