Example Docs

Quickstart

Follow these steps to create your first documentation site.

Create a New Project

npx create-docs-app my-docs
cd my-docs
pnpm install

Start the Development Server

pnpm dev

Your docs site will be available at http://localhost:3000/docs.

Project Structure

my-docs/
├── app/
│   └── docs/
│       ├── page.mdx          # Home page
│       └── getting-started/
│           └── page.mdx      # Getting started page
├── docs.config.ts            # Configuration
├── package.json
└── tsconfig.json

Add Your First Page

Create a new file at app/docs/my-page/page.mdx:

---
title: My First Page
description: This is my first documentation page.
---

# My First Page

Hello, world!

Next Steps