apos-docs

Documentation static site generator built with Eleventy.

It should work out of the box with minimal configuration. This is meant to be used in combination with GitHub Pages. The final output should work with JavaScript disabled.

Description

Takes in a docs directory along with your main README.md. Compiles the output into an apos-docs/_site directory. Adds the content of the apos-docs/_site directory to a gh-pages branch. The documentation for your repository will be available at [username].github.io/[repository name].

Documentation

• Getting started
• Design choices
• Markdown showcase

Development

To work on the generator itself:

npm i
npm run dev

This builds the site from src and docs, serves it on http://localhost:8080/, and rebuilds
whenever you edit anything under src. Templates, styles and docs refresh in place. Editing a
file in src/_plugins or src/.eleventy.js restarts eleventy automatically, since those are
only read once at startup.

Tech Stack

• node
• eleventy
• markdown-it
• prism
• tailwindcss

Used by

• https://learn-monogame.github.io/
• https://apostolique.github.io/Apos.Input/
• https://apostolique.github.io/Apos.Gui/
• https://apostolique.github.io/Apos.Camera/