search

statiqdev / Statiq.Docs

A static documentation site generator.
https://statiq.dev/docs
Other
53 stars 8 forks source link

Example on Statiq.Docs output #57

Open NikoMix opened 1 year ago

NikoMix commented 1 year ago

I've been looking to get started with Statiq.Docs however the documentation did not contain a quick answer to "what you'll get" from it.

Also, the Repository only contains two class libraries which both do not seem to generate any output and instead reflect the Statiq.Docs Framework itself. To get started and understand what requirements to the Assembly would be you want to generate a Documentation for and/or how to extend it.

Understanding the Framework is still in early stages, and there'd are other priorities- but it'd be great to get some more documentation for how to get started, what are core features (docs versus web for example) and have a GitHub Page demonstrating an output.

pascalberger commented 1 year ago

If you're looking for an example site output, you can have a look at https://www.statiq.dev/ which is built using Statiq.Docs together with the https://github.com/statiqdev/Docable theme.

Source code of it is available here: https://github.com/statiqdev/Website