{"id":28299157,"url":"https://github.com/applicative-systems/mkdocs-flake","last_synced_at":"2026-03-12T20:12:19.577Z","repository":{"id":230010441,"uuid":"778224341","full_name":"applicative-systems/mkdocs-flake","owner":"applicative-systems","description":"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]","archived":false,"fork":false,"pushed_at":"2025-09-18T09:40:28.000Z","size":630,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-18T11:42:52.043Z","etag":null,"topics":["flake-parts","mkdocs","mkdocs-material","mkdocs-plugin","nix","nix-flake"],"latest_commit_sha":null,"homepage":"https://applicative.systems/mkdocs-flake/","language":"Nix","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/applicative-systems.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-03-27T10:14:27.000Z","updated_at":"2025-09-18T09:40:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"74be2d65-f57f-45fc-9e3b-eff63a06b91f","html_url":"https://github.com/applicative-systems/mkdocs-flake","commit_stats":null,"previous_names":["applicative-systems/mkdocs-flake"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/applicative-systems/mkdocs-flake","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/applicative-systems%2Fmkdocs-flake","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/applicative-systems%2Fmkdocs-flake/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/applicative-systems%2Fmkdocs-flake/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/applicative-systems%2Fmkdocs-flake/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/applicative-systems","download_url":"https://codeload.github.com/applicative-systems/mkdocs-flake/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/applicative-systems%2Fmkdocs-flake/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30441857,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-12T14:34:45.044Z","status":"ssl_error","status_checked_at":"2026-03-12T14:09:33.793Z","response_time":114,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flake-parts","mkdocs","mkdocs-material","mkdocs-plugin","nix","nix-flake"],"created_at":"2025-05-23T07:20:26.360Z","updated_at":"2026-03-12T20:12:19.563Z","avatar_url":"https://github.com/applicative-systems.png","language":"Nix","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# mkdocs-flake\n\nEasy MkDocs integration with plugins, Material Design, PlantUML, and more!\n\n**Developed and maintained by [Applicative Systems](https://applicative.systems/)**\n\n\u003cp\u003e\n\u003ca href=\"https://github.com/applicative-systems/mkdocs-flake/actions/workflows/check.yml\"\u003e\u003cimg src=\"https://github.com/applicative-systems/mkdocs-flake/actions/workflows/check.yml/badge.svg\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://matrix.to/#/#applicative.systems:matrix.org\"\u003e\u003cimg src=\"https://img.shields.io/badge/Support-%23applicative.systems-blue\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003c/div\u003e\n\nThis project simplifies integrating [MkDocs](https://www.mkdocs.org/) with various plugins.\nEnjoy pre-bundled MkDocs, a beautiful Material Design theme, PlantUML integration,\ncode block highlighting and annotations, and availability as a Nix Flake,\nFlake-parts module, and Docker image.\n\n## Key Features\n\n* **Pre-Bundled and Easy to Use:** Get started with MkDocs quickly.\n* **MkDocs Material Design:** Beautiful and modern documentation.\n* **Markdown-Integrated PlantUML:** Create diagrams directly in your documentation.\n* **Enhanced Code Blocks:** Highlighting and annotations for your code samples.\n* **Nix Flake:** Seamless integration with Nix.\n* **Flake-parts Module:** Easily incorporate into your Nix projects.\n* **Docker Image:** Convenient deployment and usage.\n\n## Try it\n\nThere are multiple simple ways to use this mkdocs distribution:\n[integration documentation](https://applicative.systems/mkdocs-flake/integration/).\n\n### Docker\n\nA Docker image is also available.\n\n## Plugins\n\n### Diagrams\n\n  * **Mermaid:** Supported out of the box.\n  * **PlantUML:**  Provides more sophisticated diagramming capabilities,\n    including a standard library with numerous icons and styles.\n    The [C4 standard library](https://plantuml.com/c4-context) is particularly noteworthy.\n\n## Documentation\n\nVisit the full documentation site at [https://applicative.systems/mkdocs-flake](https://applicative.systems/mkdocs-flake).\n\n## Professional Services\n\nWe offer commercial support to help you succeed with `mkdocs-flake`:\n\n  * **Custom Development:** Tailored features for your needs\n  * **Integration Support:** Help with your deployment workflows\n  * **Training:** Expert guidance for your team\n  * **Consulting:** Infrastructure optimization\n\nContact us:\n\n  * 📧 [hello@applicative.systems](mailto:hello@applicative.systems)\n  * 🤝 [Schedule a meeting](https://nixcademy.com/meet)\n\n## Community\n\n  * Join our [Matrix channel](https://matrix.to/#/#applicative.systems:matrix.org)\n  * Report issues on [GitHub](https://github.com/applicative-systems/mkdocs-flake/issues)\n  * Contribute via [Pull Requests](https://github.com/applicative-systems/mkdocs-flake/pulls)\n\n## License\n\n[MIT License](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapplicative-systems%2Fmkdocs-flake","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapplicative-systems%2Fmkdocs-flake","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapplicative-systems%2Fmkdocs-flake/lists"}