Your first site

Install the CLI

Run the install command in your project folder.

npm install --save-dev @specistry/cli

Create the configuration

Add specistry.config.ts at the project root. Two fields are required: schemaVersion and name.

import { defineConfig } from "@specistry/config";

export default defineConfig({
  schemaVersion: 1,
  name: "Acme docs",
});

Write your first page

docs/index.md becomes the site homepage. Every page starts with frontmatter and a title.

---
title: Acme developer docs
description: Everything you need to integrate.
---

Welcome. Start with the quickstart.

Validate and build

Validation writes nothing. The build writes a complete artifact under .specistry/artifacts, or nothing at all.

npx specistry validate
npx specistry build