Installation

Start from the Lotus starter template for a new documentation site, or install Lotus manually when you already have an Astro project.

Starter Template

Use the starter when you want the fastest path to a working site.

pnpm create astro@latest my-docs --template prosefly/astro-template-lotus-starter
cd my-docs
pnpm dev

The template source is available at prosefly/astro-template-lotus-starter.

After the site is running, replace the example content and update src/theme.config.ts with your project name, navigation, sidebar structure, appearance, footer, and source repository.

Manual Setup

Use manual setup when your project already exists or when you want to introduce Lotus one piece at a time.

1. Install Lotus.

   Add the theme package to your Astro project.

   pnpm add @prosefly/astro-theme-lotus

   Install @prosefly/astro-components directly when your own MDX or Astro files import shared components such as cards, steps, tabs, callouts, badges, or file trees.

   pnpm add @prosefly/astro-components

2. Register the integration.

   Configure Astro with the Lotus integration.

   import { defineConfig } from 'astro/config';
   import lotus from '@prosefly/astro-theme-lotus';
   import themeConfig from './src/theme.config';
   
   export default defineConfig({
     integrations: [lotus(themeConfig)],
   });

3. Create the theme config.

   Start with project identity and a minimal sidebar.

   import { defineLotusConfig } from '@prosefly/astro-theme-lotus';
   
   export default defineLotusConfig({
     name: 'My Docs',
     description: 'Documentation for my project.',
     navbar: [{ label: 'Docs', href: '/' }],
     sidebars: [
       {
         label: 'Guides',
         icon: 'lucide:rocket',
         items: ['index'],
       },
     ],
   });

   Set docsBase: '/docs' when the Astro project already has a site home page and docs should live under /docs/.

4. Register the docs collection.

   Create src/content.config.ts and use the loader and schema from Lotus.

   import { defineCollection } from 'astro:content';
   import { docsLoader, docsSchema } from '@prosefly/astro-theme-lotus/content';
   
   const docs = defineCollection({
     loader: docsLoader(),
     schema: docsSchema(),
   });
   
   export const collections = { docs };

5. Add the first docs page.

   Lotus reads from src/content/docs by default.

   ---
   title: Overview
   description: Start here.
   ---
   
   Welcome to the docs.

6. Start development.

   pnpm dev

Next Steps

• Review Project Configuration to define the site identity, navigation, sidebars, footer, and source repository.
• Review Content Routing before moving docs under a route prefix or changing the docs loader base.
• Run pnpm check before shipping changes. It validates content collections, MDX imports, Astro components, and TypeScript.