Project documentation with Markdown.⚓︎
ProperDocs
ProperDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introductory tutorial, then check the User Guide for more information.
Features⚓︎
Great Themes Available⚓︎
Great Themes Available
There's a stack of good looking themes available for ProperDocs. Choose between the official themes: mkdocs and readthedocs, select one of the third-party themes (on the ProperDocs Catalog), or build your own.
Easy to Customize⚓︎
Easy to Customize
Get your project documentation looking just the way you want it by customizing your theme and/or installing some plugins. Modify Markdown's behavior with Markdown extensions. Many configuration options are available.
Preview your Site as you work⚓︎
Preview your Site as you work
The built-in dev-server allows you to preview your documentation as you're writing it. It will even auto-reload and refresh your browser whenever you save your changes.
Host anywhere⚓︎
Host anywhere
ProperDocs builds completely static HTML sites that you can host on GitHub Pages, Amazon S3, or anywhere else you choose.