This repository is a pnpm workspace for the Lotus Astro theme and docs site.
packages/astro-theme-lotus/contains the installable Astro integration, layouts, routes, styles, theme components, and content schema.@prosefly/astro-componentsis consumed as a published npm package.src/content/contains the example documentation site used to document and test the packages.src/theme.config.tsconfigures the example site.
Install dependencies:
pnpm installRun the local docs site:
pnpm run devValidate before submitting changes:
pnpm run check
pnpm run buildUse short, conventional-style commit messages:
type(scope): summary
- Use lowercase
typevalues such asfix,feat,docs,style,refactor,test,chore,build, andci. - Add a
scopewhen it helps identify the affected area, for exampletheme,docs,sidebar,search,content, ordeps. - Keep the summary imperative, present tense, and under 72 characters when practical.
- Use the commit body for context, migration notes, or follow-up details when a change is not self-explanatory.
Examples:
fix(theme): avoid deep Astro config type comparisons
docs: document content routing defaults
chore(deps): align Astro workspace dependencies
Keep documentation aligned with the public API in packages/astro-theme-lotus
and the published @prosefly/astro-components package.
- Update package READMEs when exports, integration options, or install steps change.
- Update the example docs in
src/content/docs/when theme behavior changes. - Prefer one canonical page for each concept, then link to it from related pages instead of duplicating full reference tables.
- When documenting routes, keep examples aligned with the default loader. The
example site uses
docsBase: '/docs',docsLoader(), and a normal Astro homepage atsrc/pages/index.astro.
Use @prosefly/astro-components for portable MDX components and Markdown/icon
helpers. Use @prosefly/astro-theme-lotus for the docs shell, theme config,
routes, layout, and Lotus-specific theme components.
Avoid importing from package internals in example documentation unless the page is explicitly documenting implementation details.
Before preparing a release, verify:
pnpm run checkpasses.pnpm run buildpasses.- Package READMEs match current exports in each
package.json. - The docs site does not describe schema-only compatibility fields as active UI features.
- Generated routes include pages, Markdown source routes, and the search index
expected for the configured
docsBase.
Package releases use npm Trusted Publishing from GitHub Actions. Configure the Lotus package's trusted publisher to this repository and workflow before pushing release tags:
@prosefly/astro-theme-lotus:.github/workflows/release.yml
Use tags named after the package version, such as 0.7.1, matching the package
version exactly. @prosefly/astro-components releases from the sibling
prosefly/astro-components repository.