This repository contains the Specmatic documentation site built with Docusaurus.
- Node.js 20 or later
- npm
- Ruby and Bundler if you want to run link verification
From the repository root:
npm install bundle install
Start the local development server:
npm run start
This starts Docusaurus in development mode. The terminal output will show the local URL, typically:
http://localhost:3000
Create a production build:
npm run build
This also runs the redirect fix-up script used by this repository.
After a build completes, serve the generated site locally:
npm run serve
To build the site and then run the local link checker:
npm run build:verified
If you only want to run the link checker after an existing build:
npm run check:links
- Docs content lives under docs.
- Static images live under static.
- Sidebar and navigation behavior is controlled through frontmatter and files like sidebars.js.