Installation

Axerity is a CLI. You do not clone or fork anything. Run it, scaffold a site, and start writing Markdown.

Requirements

• Node.js 24 or newer

Create a site

Scaffold a new site with init, then start the dev server:

pnpm dlx @axerity/cli init my-docscd my-docspnpm dlx @axerity/cli dev

npx @axerity/cli init my-docscd my-docsnpx @axerity/cli dev

bunx @axerity/cli init my-docscd my-docsbunx @axerity/cli dev

Your site is running at http://localhost:5173.

Run any command

Run every command the same way, straight through your package runner. There is no install step and no package.json to maintain, so your repo stays just content and config:

pnpm dlx @axerity/cli devpnpm dlx @axerity/cli buildpnpm dlx @axerity/cli preview

npx @axerity/cli devnpx @axerity/cli buildnpx @axerity/cli preview

bunx @axerity/cli devbunx @axerity/cli buildbunx @axerity/cli preview

dev starts the dev server, build writes the static site to ./build, and preview serves that build locally. This is the setup we recommend. It is also all you need to deploy: point your host’s build command at npx @axerity/cli build and set the output directory to build.

Pin a version

Prefer a package.json? Add Axerity as a dev dependency so the version is pinned, then call it through scripts:

pnpm add -D @axerity/cli

npm install -D @axerity/cli

bun add -d @axerity/cli

{	"scripts": {		"dev": "axerity dev",		"build": "axerity build",		"preview": "axerity preview"	}}

Now pnpm dev and pnpm build run the pinned version.

Project layout

A site is your content and one config file:

my-docs/  axerity.json     site configuration  docs/            your markdown + meta.json  public/          optional images and assets

Write Markdown in docs/, order pages with meta.json, and configure the site in axerity.json. The engine runs from its own install, so the only thing Axerity ever creates in your project is the build/ folder. The scaffold adds it to your .gitignore for you.