alnoda/mkdocs-workspace repository overview

⁠MkDocs workspace

Workspace for MkDocs projects. Build good-looking documentation websites with extended Markdown.
Create docs from all your GitHub, GitLab and Bitbucket repositories, automate periodic builds.

Check out extended Markdown tutorials⁠!

⁠Start

docker run --name space-1 -d -p 8020-8040:8020-8040 --restart=always alnoda/mkdocs-magicspace

and open localhost:8020⁠ in browser.

⁠Features

MkDocs:

• MkDocs⁠ - a fast, simple and downright gorgeous static site generator that's geared towards building project documentation.
• Material for MkDocs⁠ - gorgeous theme for MkDocs.
• PyMdown Extensions⁠ - add even more cool features of the extended markdown: sub- and superscripts, keys, magic links, sane headers etc.
• Mkdocs-macro plugin⁠ - add variables and macros written in Python!
• Mkdocs-multirepo-plugin⁠ - import docs directly from git repositories.
• Mkdocs-monorepo plugin⁠ - build multiple documentation folders in a single Mkdocs. Designed for large codebases.
• MkDocs Newsletter⁠ - show the changes of documentation repositories in a user friendly format, at the same time that it's easy for the authors to maintain.
• Mkdocs-mermaid2-plugin⁠ - renders textual graph descriptions into Mermaid graphs (flow charts, sequence diagrams, pie charts, etc.).
• Pygments⁠ - a generic syntax highlighter suitable for use in code hosting, forums, wikis or other applications that need to prettify source code, with over 500 languages and other text formats.
• Mkdocs-include-markdown-plugin⁠ - include Markdown files completely or partially, and include files of any type.
• Mkdocs-table-reader-plugin⁠ - directly insert CSV files as tables in your website.
• Mkdocs-video⁠ - Include viedeos in the documentation.
• many other plugins
• Alnoda workspace features⁠

⁠Links

Workspace docs⁠ Alnoda docs⁠
Alnoda Hub⁠