Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Example on Statiq.Docs output #57

Open
NikoMix opened this issue Jan 25, 2023 · 1 comment
Open

Example on Statiq.Docs output #57

NikoMix opened this issue Jan 25, 2023 · 1 comment

Comments

@NikoMix
Copy link

NikoMix commented Jan 25, 2023

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants