https://github.com/applicative-systems/mkdocs-flake
mkdocs-flake simplifies MkDocs setup with the latest packages, pre-bundled plugins, Material Design, PlantUML, and code highlighting. Available as a Nix flake, flake-parts module, and Docker image, it makes beautiful documentation easy. [maintainer=@tfc]
https://github.com/applicative-systems/mkdocs-flake
flake-parts mkdocs mkdocs-material mkdocs-plugin nix nix-flake
Last synced: 17 days ago
JSON representation
mkdocs-flake simplifies MkDocs setup with the latest packages, pre-bundled plugins, Material Design, PlantUML, and code highlighting. Available as a Nix flake, flake-parts module, and Docker image, it makes beautiful documentation easy. [maintainer=@tfc]
- Host: GitHub
- URL: https://github.com/applicative-systems/mkdocs-flake
- Owner: applicative-systems
- License: mit
- Created: 2024-03-27T10:14:27.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-18T09:40:28.000Z (6 months ago)
- Last Synced: 2025-09-18T11:42:52.043Z (6 months ago)
- Topics: flake-parts, mkdocs, mkdocs-material, mkdocs-plugin, nix, nix-flake
- Language: Nix
- Homepage: https://applicative.systems/mkdocs-flake/
- Size: 615 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mkdocs-flake
Easy MkDocs integration with plugins, Material Design, PlantUML, and more!
**Developed and maintained by [Applicative Systems](https://applicative.systems/)**
This project simplifies integrating [MkDocs](https://www.mkdocs.org/) 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](https://applicative.systems/mkdocs-flake/integration/).
### 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](https://plantuml.com/c4-context) is particularly noteworthy.
## Documentation
Visit the full documentation site at [https://applicative.systems/mkdocs-flake](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:
* 📧 [hello@applicative.systems](mailto:hello@applicative.systems)
* 🤝 [Schedule a meeting](https://nixcademy.com/meet)
## Community
* Join our [Matrix channel](https://matrix.to/#/#applicative.systems:matrix.org)
* Report issues on [GitHub](https://github.com/applicative-systems/mkdocs-flake/issues)
* Contribute via [Pull Requests](https://github.com/applicative-systems/mkdocs-flake/pulls)
## License
[MIT License](./LICENSE)