DocGen is a Static Website Generator
DocGen is an open-source website generator that makes it easy to create high-quality documentation.
Creates a static website that works on any server, or as local files.
Also publishes the website content as a single PDF, using wkhtmltopdf.
Write in plain text, or the human-friendly Markdown format.
Easy to version control
Plain text input formats work well with all version control systems.
Table of contents
Automatically creates tables of contents, with links and PDF page numbers.
Code syntax highlighting
Automatically highlights code blocks, using Highlight.js, with language detection.
Displays mathematical expressions without plugins, using either
Branding and metadata
Easily brand with a logo, attribute ownership, and attach release notes.
How it works
DocGen, and run the tool to generate websites and PDF documents.
001 | Create content in plain text or human-friendly Markdown
002 | DocGen styles and publishes all your content as a website
003 | DocGen also creates an equivalent PDF copy
Flexible Input Formats
- Plain text
- CommonMark (Markdown)
- LaTeX mathematical expressions
- Image diagrams
- Attach other documents
- Branding (logo, title, organization)
- License, copyright, and legal markings
- Ownership and attribution
- Version information
- Release notes (change log)
NOTE: DocGen is intended for free-form, human-generated content which is regularly updated and improved, then
automatically laid out according to a template. It is not intended as a precision PDF editing tool.
Websites and documents generated by DocGen work in most browsers
including Chrome, Edge, Firefox and Safari.
In just three steps:
- Install DocGen
- Scaffold an empty template
- Generate a static website
Simply enter these commands in the terminal:
npm install -g docgen-tool
docgen run -o $HOME/docgen-example
See the installation guide for more detailed instructions.