Configuration

Reference Lotus theme configuration fields, defaults, and related docs.

This reference lists top-level defineLotusConfig() fields. Use the linked configuration pages for examples and behavior details.

Options

Field	Default	See
`name`	`'Documentation'`	Project
`description`	`'Project documentation.'`	Project
`logo`	built-in Lotus mark	Project
`favicon`	none	Project
`appearance`	`accent: 'indigo'`, `gray: 'neutral'`, `defaultMode: 'system'`, `radius: 'medium'`	Appearance
`docsBase`	`'/'`	Content Routing
`defaultLocale`	first configured locale	Internationalization
`locales`	none	Internationalization
`ui`	built-in English messages	Internationalization
`navbar`	one Docs link	Navbar
`socials`	`[]`	Navbar
`sidebars`	`[]`	Sidebars
`footer`	empty copyright and sections	Footer
`search`	`{ provider: 'local' }`	Search
`assistant`	`false`	Assistant
`pageActions`	copy, Markdown, ChatGPT, Claude	Page Actions
`source`	inferred when possible	Source
`editLink`	hidden	Source
`contributors`	`false`	Source
`components`	`{}`	Overriding Components
`credits`	`true`	Footer
`iconify`	default Iconify API, scan enabled	Integrations
`expressiveCode`	Lotus defaults	Expressive Code
`packageManagerTabs`	enabled	Code Blocks

Helper

Use defineLotusConfig() for type inference:

import { defineLotusConfig } from '@prosefly/astro-theme-lotus';

export default defineLotusConfig({
  name: 'My Docs',
  description: 'Documentation for my project.',
});

Edit this page

Last updated Jul 18, 2026