Docgen is a fork of Doctave intending to continue the development. All credit goes to the original Docgen authors.
Docgen is an opinionated documentation site generator that converts your Markdown files into a beautiful documentation site with minimal effort.
Docgen is not a generic static site generator - it is only meant for generating documentation sites from Markdown. This allows the tool to be much simpler than other solutions, with fewer configuration steps.
This open source tool is built and maintained by Streetwriters.co.
Docgen comes with a number of documentation-specific features out of the box. No plugins needed.
- Mermaid.js diagrams
- Offline full-text search
- Local live-reloading server
- Broken links checking
- Typesetting for mathematical formulas
- Responsive design
- Dark mode
- GitHub flavored markdown
- Minimal configuration
- Symlinked files [new]
- Tabs [new]
- Static code block syntax highlighting (thanks to syntect) [new]
- Fast build times (Docgen is built with Rust)
Docgen-generated sites can be hosted on any static site hosting provider, such as GitHub Pages.
You can customize the color scheme and logo to match your own style. Below are two examples: one with Docgen's own color scheme, and another customized color scheme.
| Light | Dark |
|---|---|
| TBD | TBD |
| TBD | TBD |
There are a few installation options for Docgen. If you would like another installation option, please open an issue for it.
Docgen provides precompiled binaries for Mac, Linux, and Windows, which you can download from the latest release page.
You can also use the Rust package manager, Cargo, to install Docgen. Currently Docgen is not listed on crates.io, but you can install it directly from GitHub:
$ cargo install --git https://github.com/thecodrr/docgen
Once you have Docgen installed, you can run the init command to create an initial docs site:
$ docgen init
Then, run the serve command to preview your site locally.
$ docgen serve
Docgen | Serve
Starting development server...
Server running on http://0.0.0.0:4001/