Overview
Learn what Lotus provides and how the documentation theme is organized.
Lotus provides the page shell, navigation model, theme tokens, and shared MDX components needed to start documentation without rebuilding the chrome from scratch.
Lotus provides docs routes, responsive navigation, search, MDX components, and design tokens. The rest of the Astro project stays under your control.
pnpm add @prosefly/astro-theme-lotusHow Lotus works
Configure the shell once, write normal Markdown or MDX, and let the integration produce pages, Markdown source routes, and search data.
src/theme.config.tsexport default defineLotusConfig({
docsBase: '/docs',
appearance: {
accent: 'indigo',
},
});src/content/docs/ensrc/content/docs/en/index.mdxsrc/content/docs/en/installation.mdxsrc/content/docs/en/components/callout.mdxgenerated outputMDX components
Import components from @prosefly/astro-components. Install the package directly when you use them in your own MDX.
pnpm add @prosefly/astro-componentsnpm install @prosefly/astro-componentsyarn add @prosefly/astro-componentsStepsCardsAccordionsappearance: {
accent: 'indigo',
gray: 'neutral',
defaultMode: 'system',
radius: 'medium',
}Accent
Gray
Radius
Appearance
Configure accent color, gray scale, radius, and the default color mode in the Lotus theme config. Font and lower-level semantic CSS tokens stay available for project styles and local components.
Customize the themeBuilt for static docs
Lotus keeps the docs shell static-first, with focused client JavaScript for navigation, search, and theme controls. External reports stay one click away without turning the homepage into a score dashboard.
Installation
Install the theme package, pass the theme config directly to the integration, and register the docs content collection.
Read the installation guideimport { defineConfig } from 'astro/config';
import lotus from '@prosefly/astro-theme-lotus';
import themeConfig from './src/theme.config';
export default defineConfig({
integrations: [lotus(themeConfig)],
});@prosefly/astro-theme-lotus + @prosefly/astro-componentsdocsLoader() + docsSchema()/docs on this siteThe homepage remains a normal Astro route.