mkdocs-flake

Easy MkDocs integration with plugins, Material Design, PlantUML, and more!

Developed and maintained by Applicative Systems

This project simplifies integrating MkDocs with various plugins. Enjoy pre-bundled MkDocs, a beautiful Material Design theme, PlantUML integration, code block highlighting and annotations, and availability as a Nix Flake, Flake-parts module, and Docker image.

Key Features

• Pre-Bundled and Easy to Use: Get started with MkDocs quickly.
• MkDocs Material Design: Beautiful and modern documentation.
• Markdown-Integrated PlantUML: Create diagrams directly in your documentation.
• Enhanced Code Blocks: Highlighting and annotations for your code samples.
• Nix Flake: Seamless integration with Nix.
• Flake-parts Module: Easily incorporate into your Nix projects.
• Docker Image: Convenient deployment and usage.

Try it

There are multiple simple ways to use this mkdocs distribution: integration documentation.

Docker

A Docker image is also available.

Plugins

Diagrams

• Mermaid: Supported out of the box.
• PlantUML: Provides more sophisticated diagramming capabilities, including a standard library with numerous icons and styles. The C4 standard library is particularly noteworthy.

Documentation

Visit the full documentation site at https://applicative.systems/mkdocs-flake.

Professional Services

We offer commercial support to help you succeed with mkdocs-flake:

• Custom Development: Tailored features for your needs
• Integration Support: Help with your deployment workflows
• Training: Expert guidance for your team
• Consulting: Infrastructure optimization

Contact us:

• 📧 [email protected]
• 🤝 Schedule a meeting

Community

• Join our Matrix channel
• Report issues on GitHub
• Contribute via Pull Requests

License

MIT License