Lotus
Type to search documentation.

Getting Started

Overview

Learn what Lotus provides and how the documentation theme is organized.

View as MarkdownOpen in ChatGPTOpen in Claude

Lotus is an installable documentation theme for Astro v7, Tailwind CSS v4, and MDX. It provides the page shell, docs route, navigation model, theme tokens, and shared MDX components needed to start a project documentation site without rebuilding the chrome from scratch.

What Lotus includes

Docs shell

Render a responsive header, docs subnav, sidebar, article layout, table of contents, page metadata, and footer from theme configuration.

Routing

Generate docs pages, Markdown source routes, search indexes, localized URLs, and route-prefixed docs from Astro content collection entries.

Search

Use the built-in client-side search dialog and generated JSON index, or replace the search UI with a component override.

Design tokens

Configure accent colors, gray scales, radius, color mode, fonts, and lower level CSS tokens for deeper styling control.

MDX components

Compose pages with callouts, cards, steps, tabs, accordions, file trees, badges, and Iconify icons from @prosefly/astro-components.

Overrides

Replace shell slots such as search, navbar, page header, page actions, contributors, and previous or next navigation when configuration is not enough.

How the docs tree works

Lotus reads MDX entries from the docs content collection, then injects page, Markdown source, and search routes under docsBase. With the default docsBase: '/', Lotus generates:

  • / and nested docs pages
  • /*.md Markdown source routes
  • /search.json search index data

The sidebars config decides which sidebar and subnav section owns each page. For locale directories, route prefixes, and fallback behavior, see Internationalization. For loader base, docsBase, and slug behavior, see Content Routing.

First steps

  1. Install the theme.

    Add Lotus, then register the integration in astro.config.ts. Install @prosefly/astro-components directly when your own content imports shared MDX components.

    Install Lotus

  2. Configure routes and locales.

    Decide where docs are mounted and how localized content directories map to public URLs.

    Review content routing

  3. Build the docs shell.

    Set project identity, appearance, navbar links, sidebars, footer links, page actions, and search behavior.

    Configure the project

  4. Write content.

    Add frontmatter, Markdown, images, code blocks, and shared MDX components to replace the demo pages with project documentation.

    Review authoring essentials

  5. Customize when configuration is not enough.

    Use CSS tokens for visual changes and component overrides for shell markup or behavior changes.

    Customize Lotus

Last updated Jul 18, 2026

Contributors