The ABP Docs Module provides a simple way to add documentation to your web application. Create, organize, and store documents securely with GitHub integration, versioning support, and multi-language capabilities.
The Docs Module integrates directly with GitHub, allowing you to write and manage documents directly on GitHub while serving them through your application.
Manage your documentation directly in GitHub repositories. The Docs Module automatically serves documents from your GitHub repository, keeping your documentation in sync with your codebase and enabling collaborative editing.
Write and manage documents directly on GitHub
Users can click Edit links to contribute on GitHub
Leverage GitHub's version control for documentation
Enable community contributions through GitHub
The Docs Module includes all essential features needed to create and maintain professional documentation for your application or project.
Versioning support directly integrated with GitHub releases. Manage multiple versions of your documentation and allow users to access specific versions or the latest version.
Support multiple languages with fallback to default language. Create documentation in different languages and automatically serve the appropriate version based on user preferences.
Host multiple project documentation in a single application. Manage documentation for different projects, products, or modules from one central location.
In addition to GitHub integration, you can also use a directory as the documentation source. Choose the storage method that works best for your workflow.
Write documentation in the format that works best for your team. The Docs Module supports both Markdown and HTML formats.
Write documentation using Markdown, a lightweight markup language that makes content creation simple and intuitive. Perfect for technical documentation and developer-focused content.
Use HTML format for more complex documentation needs. Full control over styling and structure when Markdown isn't sufficient for your requirements.
Help users navigate your documentation easily with built-in navigation and outline features that improve discoverability and user experience.
Manage documentation for multiple projects from a single platform, with a centralized and consistent experience.
Manage documentation for multiple projects, products, or modules from a single application. Each project can have its own configuration, versioning, and language settings, making it easy to maintain comprehensive documentation across your entire product portfolio.
Powering ABP Framework docs at scale for complex, production-ready systems.
The Docs Module is used by ABP Framework to host its own documentation at docs.abp.io. This real-world implementation demonstrates the module's reliability, scalability, and feature completeness for production documentation sites.
Completely free and open-source, giving you full control over the blogging infrastructure of your application.
The Docs Module is completely free and open-source. The source code is available on GitHub, licensed under MIT, allowing you to use, customize, and extend it freely for your documentation needs.
Docs works seamlessly with multiple databases and UI frameworks, giving you complete freedom in how you build.
All starter templates offer multiple options for implementing your data access layer.
ABP allows you to build with multiple UI framework options.
Explore detailed documentation, API references, and implementation guides.
