|
| 1 | +<div align="center"> |
| 2 | + |
| 3 | +# mkdocs-flake |
| 4 | + |
| 5 | +Easy MkDocs integration with plugins, Material Design, PlantUML, and more! |
| 6 | + |
| 7 | +**Developed and maintained by [Applicative Systems](https://applicative.systems/)** |
| 8 | + |
| 9 | +<p> |
| 10 | +<a href="https://github.com/applicative-systems/mkdocs-flake/actions/workflows/main.yml"><img src="https://github.com/applicative-systems/mkdocs-flake/actions/workflows/main.yml/badge.svg"/></a> |
| 11 | +<a href="https://matrix.to/#/#applicative.systems:matrix.org"><img src="https://img.shields.io/badge/Support-%23applicative.systems-blue"/></a> |
| 12 | +</p> |
| 13 | + |
| 14 | +</div> |
| 15 | + |
| 16 | +This project simplifies integrating [MkDocs](https://www.mkdocs.org/) with various plugins. |
| 17 | +Enjoy pre-bundled MkDocs, a beautiful Material Design theme, PlantUML integration, |
| 18 | +code block highlighting and annotations, and availability as a Nix Flake, |
| 19 | +Flake-parts module, and Docker image. |
| 20 | + |
| 21 | +## Key Features |
| 22 | + |
| 23 | +* **Pre-Bundled and Easy to Use:** Get started with MkDocs quickly. |
| 24 | +* **MkDocs Material Design:** Beautiful and modern documentation. |
| 25 | +* **Markdown-Integrated PlantUML:** Create diagrams directly in your documentation. |
| 26 | +* **Enhanced Code Blocks:** Highlighting and annotations for your code samples. |
| 27 | +* **Nix Flake:** Seamless integration with Nix. |
| 28 | +* **Flake-parts Module:** Easily incorporate into your Nix projects. |
| 29 | +* **Docker Image:** Convenient deployment and usage. |
| 30 | + |
| 31 | +## Try it |
| 32 | + |
| 33 | +There are multiple simple ways to use this mkdocs distribution: |
| 34 | +[integration documentation](https://applicative.systems/mkdocs-flake/integration/). |
| 35 | + |
| 36 | +### Docker |
| 37 | + |
| 38 | +A Docker image is also available. |
| 39 | + |
| 40 | +## Plugins |
| 41 | + |
| 42 | +### Diagrams |
| 43 | + |
| 44 | + * **Mermaid:** Supported out of the box. |
| 45 | + * **PlantUML:** Provides more sophisticated diagramming capabilities, |
| 46 | + including a standard library with numerous icons and styles. |
| 47 | + The [C4 standard library](https://plantuml.com/c4-context) is particularly noteworthy. |
| 48 | + |
| 49 | +## Documentation |
| 50 | + |
| 51 | +Visit the full documentation site at [https://applicative.systems/mkdocs-flake](https://applicative.systems/mkdocs-flake). |
| 52 | + |
| 53 | +## Professional Services |
| 54 | + |
| 55 | +We offer commercial support to help you succeed with `mkdocs-flake`: |
| 56 | + |
| 57 | + * **Custom Development:** Tailored features for your needs |
| 58 | + * **Integration Support:** Help with your deployment workflows |
| 59 | + * **Training:** Expert guidance for your team |
| 60 | + * **Consulting:** Infrastructure optimization |
| 61 | + |
| 62 | +Contact us: |
| 63 | + |
| 64 | + * 📧 [hello@applicative.systems](mailto:hello@applicative.systems) |
| 65 | + * 🤝 [Schedule a meeting](https://nixcademy.com/meet) |
| 66 | + |
| 67 | +## Community |
| 68 | + |
| 69 | + * Join our [Matrix channel](https://matrix.to/#/#applicative.systems:matrix.org) |
| 70 | + * Report issues on [GitHub](https://github.com/applicative-systems/mkdocs-flake/issues) |
| 71 | + * Contribute via [Pull Requests](https://github.com/applicative-systems/mkdocs-flake/pulls) |
| 72 | + |
| 73 | +## License |
| 74 | + |
| 75 | +[MIT License](./LICENSE) |
0 commit comments