Home
This project can be used as a template for repository documentation. It's goal is two-fold:
- provide usage examples on how a diataxis based documentation could work including features from mkdocs that allow lighting up the content.
- provide a drop-in documentation framework anyone can just intall into their repository
To see a working example, see diataxis-template. Pro-tip: make sure you add the link to the working example so you can off-load learning how to use the template to the example
Features¶
- Basic diataxis structure
- MkDocs basic config
- Convention based folder structure using awesome-pages
- read the docs
- Basic templates
- Printing of the entire site
- Distribution scripts
Get Started¶
- See Getting Started for a tutorial on getting started with development
- See Tutorials section for all tutorials
FAQ¶
See faq for a list of known issues.
Contributing¶
Please see contributing guide for more information.
License¶
See license page or LICENSE.md file for more information.
Acknowledgements¶
Diataxis templates was based on adolfomaltez/diataxis
References: