Skip to content

Development setup

There is no build step. The CLI is plain ES modules (bin/cli.mjs, src/*.mjs).

Terminal window
git clone https://github.com/mindovermachine-dev/remote-astro-theme
cd remote-astro-theme
npm install

Link the working copy into the repo that uses it:

Terminal window
# in remote-astro-theme
npm link
# in the content repo
npm link remote-astro-theme

Edits are live on the next run. A later npm install in the content repo replaces the link, so link again afterwards.

In the content repo’s steering config, point at the theme folder:

theme: "file:../my-theme",

Change it back to a git reference before committing.

These docs are built by the CLI itself:

Terminal window
npm run docs:dev
npm run docs:build

They use mom-doc-theme from its main branch. To test against a local copy, temporarily set theme: "file:../mom-doc-theme" in docs/site.config.mjs.

Terminal window
npm run check

This syntax-checks every source file.