README.md

Open Job Spec Website

The documentation website for Open Job Spec, built with Astro and Starlight.

Development

Prerequisites

• Node.js 18 or later
• pnpm

Install dependencies

pnpm install

Start the dev server

pnpm dev

The site will be available at http://localhost:4321.

Build for production

pnpm build

The static output is written to dist/.

Preview the production build

pnpm preview

Project structure

website/
├── public/              # Static assets (favicon, images)
├── src/
│   ├── assets/          # Processed assets (images optimized by Astro)
│   ├── components/      # Custom Astro components
│   ├── content/
│   │   └── docs/        # MDX documentation pages
│   │       ├── getting-started/
│   │       ├── spec/
│   │       ├── guides/
│   │       ├── reference/
│   │       ├── ecosystem/
│   │       └── governance/
│   └── styles/          # Custom CSS
├── astro.config.mjs     # Astro + Starlight configuration
├── package.json
└── tsconfig.json

Adding content

All documentation pages are MDX files in src/content/docs/. Each file needs frontmatter with at least title and description:

---
title: Page Title
description: A short description for SEO and link previews.
---

Page content here.

The sidebar is configured in astro.config.mjs under the Starlight sidebar option.