Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

specmatic/docs.specmatic.io

Repository files navigation

docs.specmatic.io

This repository contains the Specmatic documentation site built with Docusaurus.

Prerequisites

  • Node.js 20 or later
  • npm
  • Ruby and Bundler if you want to run link verification

Install dependencies

From the repository root:

npm install
bundle install

Run the docs site locally

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

Build the site locally

Create a production build:

npm run build

This also runs the redirect fix-up script used by this repository.

Preview the built site

After a build completes, serve the generated site locally:

npm run serve

Validate links

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

Helpful notes

  • Docs content lives under docs.
  • Static images live under static.
  • Sidebar and navigation behavior is controlled through frontmatter and files like sidebars.js.

AltStyle によって変換されたページ (->オリジナル) /