Apos Docs
Documentation static site generator.
Overview
Apos-docs is a documentation static site generator built with Eleventy. It is designed to work out of the box with minimal configuration and is meant to be used in combination with GitHub Pages. The final output of the generator is expected to work even with JavaScript disabled.
Features
- Simple Configuration: Apos-docs requires minimal configuration and should work out of the box.
- GitHub Pages integration: The output of the generator is automatically added to a gh-pages branch, making it easy to host the documentation on GitHub Pages.
- JavaScript Disabled Compatibility: The generated documentation is designed to work even with JavaScript disabled.
Summary
Apos-docs is a documentation static site generator that works seamlessly with GitHub Pages. It provides a simple configuration process, GitHub Pages integration, and ensures compatibility even with JavaScript disabled. The installation process involves installing the package using npm and running a command to generate the documentation output. Apos-docs is used by several projects including Learn Monogame, Apos.Input, Apos.Gui, and Apos.Camera.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.