Build

Generate the catalogue

npx mokly build

Build validates your entries, renders every screen, page and Markdown document and writes the result under <mockupsDir>/mokly-generated/: documents, mokly-manifest.json, compiled CSS in styles/ and copied assets in assets/. Writes are transactional, so a failed build leaves the previous output in place.

Ignore the output, or commit it

Choose with Git, not a config option. To keep generated output local, add /specs/generated/mokly-generated/ to .gitignore; Check validates sources but ignores local generated files. To commit output, track every file under mokly-generated/ and commit them after Build. Check then compares the entire tree, reporting missing, stale or extra files. Partial tracking is an error to Check only; Build succeeds when you add a new entry, then Check lists its new route under untracked: until staged. Baseline comparisons independently read complete Git output or rebuild that historical commit without inspecting head tracking.

Use npx mokly build --watch to update the tree after every successful compilation while editing. Plain serve and export do not write it; use serve --build if browsing should also update generated files.

A build fails, naming the file and the fix, when two files derive the same path, when a file name contains a character that cannot be part of a path, when a module exports no definition, or when a link names a path that does not exist.

Mokly keeps private state in .mokly-cache/ at the repository root and writes a .gitignore file inside it, so Git never shows or adds that folder. Also list .mokly-cache/ in your root .gitignore when other tools, such as formatters or linters, read only that file.

Validate without writing

npx mokly check

Check calculates the same bytes without writing them. Untracked output need not exist or match; tracked output must match exactly. Check alone rejects indexed cache paths; writers never check the index.

Next

Open the catalogue in your browser.