GrazeDocs is a new open source static documentation site generator. GrazeDocs converts your Markdown files into full-blown static HTML-pages which you can host anywhere. GrazeDocs uses Razor for themes and it is available as a .NET Core Global Tool.
Project home site: https://grazedocs.io
Project repository: https://github.com/mikoskinen/GrazeDocs
Here’s a list of few interesting features provided by GrazeDocs:
- Clean and light default theme
- Automatically generated table of contents
- Live preview
Live previews is one of the standout features: Live Preview automatically opens a browser with your published documentation site. Every time you update the documentation, the site is automatically updated. You don’t have to manually publish your site to make sure your site looks correct. The Live Preview is done using SignalR.
GrazeDocs aims to make it easy to get started by using conventions but it also tries to offer customization options if you aren’t happy with the defaults. For more thorough guides, please visit the documentation available at https://grazedocs.io or the samples at https://github.com/mikoskinen/GrazeDocs/tree/master/samples
GrazeDocs is available as a global tool for .NET Core. To install:
dotnet tool install -g GrazeDocs
To start creating your documentation, use GrazeDocs -i . to initialize documentation into the current folder:
GrazeDocs -i .
After your happy with the documentation, use GrazeDocs -p to publish your complete site:
Examples and more information
GrazeDocs home page is created using GrazeDocs. You can find the site’s source code from https://github.com/mikoskinen/GrazeDocs/tree/master/docs
For more information, GrazeDocs samples are good starting point as is https://GrazeDocs.io.