Open source · General
site-docs
The source of docs.avunu.net: the build that turns the docs/ folder of every Avunu project into one site.
- License MIT
- Platform General
Start here
- GuideGuideHow to write documentation for the site, add a project to it, preview a build and fix a failing check.
- GuideWriting documentationThe Markdown conventions that work on GitHub, in Obsidian and on the site, and the few constructs the site cannot render.
- GuideAdding a projectHow a repository gets onto the site, what it keeps, how its documentation reaches the site after a release, and how a project is renamed or removed.
- GuidePreviewingHow to build the site, or one project of it, from a local checkout and look at the result before anything is merged.
- GuideTroubleshootingMessages the build prints, what causes them and how to fix them, and how to look inside a build when something is wrong.
- ReferenceReferenceThe complete lists of commands and options, exit codes, registry settings, build steps and workflows.
site-docs is part of Avunu's open-source work: tools we build for our own client projects and share with everyone.
See every project