Module

Docs

Publish your technical documentation with a clean and professional UI.

Overview

Great module to create documentation for your ABP project.

  • Built-in GitHub integration. Directly write and manage documents on GitHub.
  • Versioning support directly integrated into GitHub releases.
  • Supports multi-language with fallback support to the default language.
  • Supports Markdown and HTML formats.
  • Provides a navigation and outline section.
  • Allows to host multiple projects documentation in a single application.
  • Links to the file on GitHub, so anyone can easily contribute by clicking on the Edit link.
  • Supports file-system. In addition to the GitHub integration, you can also use a directory as the documentation source.

ABP Framework uses this module to host its documentation. See docs.abp.io. A screenshot from the ABP documentation:

docs-module-ui

Check out the package details abp.io/package-detail/Volo.Docs.Application.

This module is free and open source. The source-code is available at github.com/abpframework/abp/tree/dev/modules/docs.

Database Providers

UI Frameworks

Useful Links

Documentation