Open source · General
docusystem
The documentation system shared by every Avunu open-source project: a CLI that builds a project's Markdown into its docs site, and the reusable workflows that check and deploy it.
- License MIT
- Platform General
Start here
- GuideGuideHow to add the documentation system to a repository, write for it, publish it, customize it and keep it current.
- GuideGetting startedAdd the documentation site to a repository in three commands, check it, preview it and commit it.
- GuideWriting documentationThe Markdown conventions that work on GitHub, in Obsidian and on the site, and the few constructs the site cannot render.
- GuidePublishingWhat the two caller workflows do, what a maintainer sets once in GitHub and DNS, and how Dependabot keeps the site current.
- GuideCustomizingThe ladder from config values to replaced files, what each rung costs in upgrades, and how to use theme tokens, static files, eject and the jx fragment.
- GuideUpgradingHow a documentation site takes a new release of the package, what each kind of release can change, and how to check the result.
docusystem is part of Avunu's open-source work: tools we build for our own client projects and share with everyone.
See every project