Community documentation of d77void Immutable: how the system works and how to run and recover it yourself.
The pages are plain Markdown in src/, readable on GitHub, in any
editor or with less. src/SUMMARY.md is the table of
contents and the only place where the order of the chapters is defined.
The website is generated with mdBook, with its default theme and no plugins. mdBook is only needed to build the site; d77void Immutable itself does not need it.
mdbook build # the site goes to book/
mdbook serve # preview at http://localhost:3000, rebuilt on every changeA link in SUMMARY.md to a page that does not exist stops the build
(create-missing = false in book.toml).
- Everything is specific to d77void Immutable. General Void Linux topics are in the Void Linux Handbook.
- Nothing is written from memory: commands, file names and behaviour are checked against the system's code and, where a page says so, on a real installation. What is not verified yet says so.
- The documentation shows commands; nothing here runs them.
On every change to src/ on main, the workflow wiki.yml copies the pages
to the d77void wiki on SourceForge
(tools/sf-wiki-sync.py, with the SF_WIKI_TOKEN secret). Pages are written
here only: the wiki copy is overwritten each time. A page removed from
SUMMARY.md stays on the wiki until it is deleted there by hand.
The documentation is licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).