A simple, ready-to-use template for adding documentation using github pages.
Key features:
- Editing done in github
- Uses github pages and a github action to deploy the content to
<handle>.github.io/<repo> - Supports markdown editing
- Supports diagrams (written directly in the markdown): PlantUML, Mermaid, others
- Uses the Just-the-docs Jekyll theme
- Search functionality built in
- Hierarchical navigation with left-side menu
- Other features - feel free to discover