{"id":26666368,"url":"https://github.com/mdevpro78/mkdocforge","last_synced_at":"2026-04-12T17:11:59.160Z","repository":{"id":284365083,"uuid":"953910595","full_name":"Mdevpro78/mkdocforge","owner":"Mdevpro78","description":"Ready To Use MkDocs Documentation Platform with Advanced Features","archived":false,"fork":false,"pushed_at":"2025-03-25T13:51:44.000Z","size":3,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-25T14:40:46.619Z","etag":null,"topics":["docker","docker-compose","documentation","mkdocs","mkdocs-material","mkdocs-plugin","mypy","pre-commit","python","vagrant","vagrantfile"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/Mdevpro78.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":"docs/CODE_OF_CONDUCT.md","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}},"created_at":"2025-03-24T09:21:18.000Z","updated_at":"2025-03-25T13:51:49.000Z","dependencies_parsed_at":"2025-03-25T14:40:48.911Z","dependency_job_id":"9b878475-c1e9-4ea3-bf42-9288f2eb12c2","html_url":"https://github.com/Mdevpro78/mkdocforge","commit_stats":null,"previous_names":["mdevpro78/mkdocforge"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mdevpro78%2Fmkdocforge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mdevpro78%2Fmkdocforge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mdevpro78%2Fmkdocforge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mdevpro78%2Fmkdocforge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mdevpro78","download_url":"https://codeload.github.com/Mdevpro78/mkdocforge/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245518568,"owners_count":20628554,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["docker","docker-compose","documentation","mkdocs","mkdocs-material","mkdocs-plugin","mypy","pre-commit","python","vagrant","vagrantfile"],"created_at":"2025-03-25T18:26:08.804Z","updated_at":"2026-04-12T17:11:59.152Z","avatar_url":"https://github.com/Mdevpro78.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MkDocForge\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://img.shields.io\"\u003e\u003cimg src=\"https://img.shields.io/badge/Project%20Status-Active-green.svg\" alt=\"Project Status: Active\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.python.org/downloads/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Python-3.11+-blue.svg\" alt=\"Python Version\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.mkdocs.org\"\u003e\u003cimg src=\"https://img.shields.io/badge/docs-mkdocs-blue.svg\" alt=\"Documentation\"\u003e\u003c/a\u003e\n\u003ca href=\"LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-MIT-yellow.svg\" alt=\"License\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\u003cem\u003eA comprehensive documentation platform powered by MkDocs with advanced features for technical documentation.\u003c/em\u003e\u003c/p\u003e\n\n## 📚 Overview\n\nMkDocForge is a powerful documentation platform built on top of MkDocs that provides enhanced features for creating beautiful, functional, and comprehensive technical documentation. It combines the simplicity of Markdown with advanced capabilities like versioned documentation, code documentation via Doxygen integration, diagrams, and a rich set of plugins to create professional documentation sites.\n\n## 🎯 Purpose\n\nMkDocForge addresses common documentation challenges by providing:\n\n- **Unified Documentation**: Combine API references, user guides, architecture decisions, and more in one platform\n- **Versioned Documentation**: Track and maintain documentation across different software versions\n- **Code Integration**: Automatically generate API documentation from source code comments\n- **Rich Media Support**: Easily embed diagrams, images, and interactive elements\n- **Collaborative Workflow**: Git-based workflow for documentation-as-code practices\n\n## ✨ Key Features\n\n- 🎨 **Material Design Theme**: Beautiful, responsive documentation with light/dark mode\n- 📊 **Diagram Support**: PlantUML integration for architectural and flow diagrams\n- 🔄 **Versioned Documentation**: Maintain docs for multiple software versions with Mike\n- 📝 **Markdown Extensions**: Enhanced markdown with admonitions, tabs, code annotations\n- 🧩 **Plugin Ecosystem**: Extensive collection of plugins for advanced functionality\n- 🐳 **Docker Support**: Containerized environment for consistent documentation builds\n- 🔍 **Full-Text Search**: Powerful search capabilities across documentation\n- 💻 **Code Documentation**: Doxygen integration for automatic code documentation\n\n## 🚀 Getting Started\n\n### Prerequisites\n\n- Python 3.11+\n- pip, uv, or another Python package manager\n\n### Quick Installation\n\n```bash\n# Clone the repository\ngit clone https://github.com/Mdevpro78/mkdocforge\ncd mkdocforge\n\n# Install dependencies using UV (recommended)\nmake uv_sync_docs\n\n# Or using pip\npip install -e .[docs]\n```\n\n### Running Locally\n\n```bash\n# Start the development server\nmake uv_mkdoc_serve\n\n# Or using UV directly\nuv run mkdocs serve\n```\n\n### Using Docker\n\nMkDocForge can be easily run using Docker:\n\n```bash\n# Build the Docker image\nmake docker-build\n\n# Start the container\nmake docker-up\n\n# View logs\nmake docker-logs\n\n# Stop the container\nmake docker-down\n```\n\nAlternatively, you can use Docker Compose directly:\n\n```bash\n# Build and start in one command\ndocker compose up\n\n# Or build and start in detached mode\ndocker compose up -d\n```\n\nOnce running, access the documentation at [http://localhost:8000](http://localhost:8000).\n\n## 📁 Project Structure\n\n```\n.\n├── docs/                  # Documentation source files\n│   ├── architecture/      # Architecture decision records\n│   ├── blog/              # Blog posts\n│   ├── examples/          # Example configurations and code\n│   ├── git/               # Git workflow documentation\n│   ├── glossary/          # Project terminology\n│   ├── python/            # Python development guides\n│   └── ...                # Other documentation sections\n├── .github/               # GitHub workflows and CI/CD\n├── scripts/               # Utility scripts\n├── Dockerfile             # Docker configuration\n├── mkdocs.yml             # MkDocs configuration\n└── pyproject.toml         # Python project configuration\n```\n\n## 🔧 Configuration\n\nMkDocForge is highly configurable through the `mkdocs.yml` file. See the [MkDocs documentation](https://www.mkdocs.org/) for basic configuration and explore our examples for advanced setups.\n\n## 🤝 Contributing\n\nContributions are welcome! Please check out our [Contributing Guide](docs/contributing.md) for guidelines on how to make contributions.\n\n## 👥 Target Audience\n\n- **Development Teams**: Create comprehensive documentation for software projects\n- **Technical Writers**: Leverage markdown with powerful extensions for technical content\n- **Open Source Projects**: Provide high-quality documentation with minimal overhead\n- **Organizations**: Maintain consistent documentation standards across projects\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 🔗 Links\n\n- [Repository](https://github.com/Mdevpro78/mkdocforge)\n- [Visit Documentation](https://mdevpro78.github.io/mkdocforge/)\n- [MkDocs Official Site](https://www.mkdocs.org/)\n- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdevpro78%2Fmkdocforge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmdevpro78%2Fmkdocforge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmdevpro78%2Fmkdocforge/lists"}