docs

Monque Documentation

Documentation site for the Monque job scheduler, built with Astro Starlight.

Tech Stack

• Framework: Astro
• Documentation Theme: Starlight
• API Documentation: TypeDoc with Starlight TypeDoc Plugin

Getting Started

1. Install dependencies:

   bun install

2. Start the development server:

   # From the repo root
   bun run dev:docs
   
   # Or from within apps/docs
   cd apps/docs && bun run dev

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

Building

To build the static documentation site:

# From the repo root
bun run build:docs

# Or from within apps/docs
cd apps/docs && bun run build

The output will be in the dist/ directory.

Project Structure

• src/content/docs: Markdown and MDX files for the documentation pages.
• src/assets: Static assets like images.
• src/styles: Custom CSS.
• astro.config.mjs: Astro and Starlight configuration.
• package.json: Dependencies and scripts.

Contribution

To add a new documentation page:

1. Create a new .md or .mdx file in src/content/docs/.
2. Add the page to the sidebar configuration in astro.config.mjs if you want it to appear in the navigation menu.