Scrii Documentation
Scrii Documentation
Source for https://scrii.okina.codefloe.page. Plain Markdown, built with
docmd.
Prerequisite
docmd installed globally (npm install -g @docmd/core), so no node_modules
or package.json lives here. Verify with docmd --version.
Commands
Run from this directory (scrii/docs/):
docmd dev # live preview with hot reload
docmd build # static site into ./dist/
docmd validate # check internal links and references
Always run build and validate from a clean output directory — the
builder writes generated Markdown (search/knowledge bundles) into dist/,
which would otherwise be picked up as source pages (phantom pages, false
link errors) on the next run:
rm -rf dist && docmd build
rm -rf dist && docmd validate
Publishing
./publish.sh [repo-url] [branch] builds, syncs dist/ onto the target
branch, and pushes. Defaults to the pages branch of the scrii repo:
./publish.sh # publish to pages
DRY_RUN=1 ./publish.sh # show what would change
./publish.sh http://htpc:3000/cory/scrii draft-docs # preview branch
dist/ is git-ignored build output; the published copy lives on the target
branch, not on main.