BearMinion documentation
BearMinion is three things: the bearminion package (the content model, the Astro integration and the dev-only editor), the default template, a complete site you own after creating it, and create-bearminion, which copies that template into a new folder (npm create bearminion@latest). New here? Start with Getting started: create a site, edit it and put it online in a few minutes.
| Page | Read it to |
|---|---|
| Getting started | Create a site with npm create bearminion, edit it, and deploy it to Vercel, Netlify or Cloudflare |
| Content files | Edit site.json and page JSON by hand, understand what the editor writes, migrate content after a schema change |
| Building a theme | Define section types, the header and footer, fonts, the live preview and content collections |
| The editor | Learn every editing feature: inline text, sections, the sidebar tabs, images, drafts, saving, history and git |
| Astro integration and package | Configure bearminion() in astro.config.ts, use the entry points, plug in a custom content store |
| Dev API | Call the localhost API the editor uses, with curl examples |
To start from Astro’s own CLI instead, npm create astro@latest -- --template langehelp-software/bearminion/templates/default my-site copies the same template as it is in the repository, Storybook and BearMinion branding included.
The template’s own guide covers its components, SEO, Storybook and adding a section type.