Build

Generate the catalogue

npx mokly build

Build validates your entries, renders every screen and writes the result under mockupsDir: one document per viewport and color scheme, plus mokly-manifest.json. Writes are transactional, so a failed build leaves the previous output in place.

Derive the output, or commit it

By default generated files stay out of Git. Add ignore rules for the generated routes, the manifest and .mokly-cache/. mokly check requires those paths to be untracked and validates the current compilation without comparing local generated bytes.

Set generatedOutput: "committed" when you want Git to hold the generated catalogue. Commit the generated routes and manifest. Check then proves their bytes match the current compilation, and a comparison reads its baseline straight from Git without running a historical build.

Validate without writing

npx mokly check

Check calculates the same bytes without writing them. In the default derived mode it reports generated files or cache paths tracked by Git. It does not require local generated files to exist or match.

Next

Open the catalogue in your browser.