Pizza Marketplace — Documentation Site

The official documentation website for the Pizza Marketplace project, built with Astro and the Starlight docs theme.

Table of Contents

• Overview
• Tech Stack
• Prerequisites
• Getting Started
• Available Scripts
• Project Structure
• Writing Documentation
• Contributing
• License

Overview

This site serves as the central reference for the Pizza Marketplace project. It covers:

• Project architecture and design decisions
• Local development setup guides
• API reference documentation
• Contributor guidelines

Tech Stack

Layer	Technology
Site framework	Astro v6
Docs theme	Starlight v0.38
Content format	Markdown (.md) and MDX (.mdx)
Image optimization	sharp
Package manager	pnpm

Prerequisites

• Node.js >= 20
• pnpm >= 9 — install with npm install -g pnpm

Getting Started

1. Clone and install dependencies

git clone <repository-url>
cd realworld-angular-docs
pnpm install

2. Start the development server

pnpm dev

The docs site will be available at http://localhost:4321 and reloads automatically as you edit content.

Available Scripts

Script	Description
pnpm dev / pnpm start	Start the dev server at http://localhost:4321
pnpm run build	Build the production site to dist/
pnpm run preview	Preview the production build locally
pnpm astro ...	Run Astro CLI commands (e.g. astro add, astro check)

Project Structure

realworld-angular-docs/
├── public/                  # Static assets (favicons, etc.)
├── src/
│   ├── assets/              # Images referenced in documentation
│   └── content/
│       └── docs/            # All documentation pages
│           ├── index.mdx    # Homepage / landing page
│           ├── guides/      # How-to guides
│           └── reference/   # API and technical reference
├── astro.config.mjs         # Astro + Starlight configuration
└── tsconfig.json

Writing Documentation

All documentation lives in src/content/docs/. Each .md or .mdx file becomes a route based on its file path.

Adding a new page

1. Create a new .md or .mdx file inside src/content/docs/
2. Add frontmatter at the top:

---
title: My New Page
description: A short description of this page.
---

Your content here.

3. The page will automatically appear in the sidebar based on the Starlight configuration in astro.config.mjs.

Adding images

Place images in src/assets/ and reference them with a relative path:

![Alt text](../../assets/my-image.png)

MDX

Use .mdx for pages that need interactive components or custom Astro/React components embedded in the content.

Sidebar configuration

The sidebar is configured in astro.config.mjs under the starlight plugin options. Update the sidebar array to add, reorder, or group pages.

Contributing

We welcome contributions to the documentation! If you find something outdated, unclear, or missing:

• Fork the repository and create your branch from main
• Edit or add .md/.mdx files in src/content/docs/
• Preview your changes locally with pnpm dev
• Open a pull request with a description of what you changed and why

Reporting Issues

If you spot an error or want to suggest new content, please open an issue with:

• The page URL or file path
• What is incorrect or missing
• A suggested correction or improvement (if applicable)

License

This project is licensed under the MIT License.