Quick Start

This guide walks you through creating your first documentation site with Lumen. By the end of this tutorial, you’ll have a functional site ready to be enriched with your content.

Prerequisites

Before you begin, make sure you have the following tools installed on your machine:

• Node.js version 18 or higher
• pnpm as your package manager (recommended)

You can check your versions with the following commands:

node --version
pnpm --version

Create a New Project

Lumen provides a project scaffolding tool that configures everything automatically. Run the following command in your terminal:

pnpm create astro@latest my-docs -- --template starlight

The wizard will ask you a few questions:

1. Project name — Choose a descriptive name for your documentation.
2. TypeScript — We recommend enabling TypeScript for a better development experience.
3. Git — Initialize a Git repository to track your change history.

Project Structure

Once the project is created, you’ll get the following directory tree:

my-docs/
├── astro.config.mjs    # Site configuration
├── src/
│   ├── assets/         # Images and static files
│   ├── content/        # Documentation pages
│   │   └── docs/
│   │       ├── index.mdx
│   │       ├── guides/
│   │       └── reference/
│   └── styles/         # Custom CSS styles
├── public/             # Public files (favicon, etc.)
└── package.json

Start the Development Server

Launch the local server to preview your documentation:

pnpm dev

Open http://localhost:4321 in your browser. Any change to a source file automatically reloads the page.

Next Steps

You now have a working documentation site. Check out the installation guide to connect Lumen to your existing project, or the configuration guide to customize the look and feel of your site.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.