Documentation
Build the content layer you can keep.
Start locally, understand the model, and take the same files to production.
Start here
Choose how to run Mica
Pick the local editor or the self-hosted editor in one minute, and see how they work together on one repository.
7 min readGetting started
Add Mica to an Astro 7 project and edit its content on your machine with the local editor.
6 min readScope and non-goals
What Mica does, what it does not do and how to work without it, how it compares with other Git-based editors, and how to undo a publish.
Build
Content model
Define typed collections, singletons, validation, and the layout on disk.
3 min readReference data
Link entries to data of the website that Mica does not edit, such as thousands of place names from a file.
6 min readChange the model
Which model changes are safe, which need a change to the content, and a tested script for each common case.
8 min readRecipes
Images with alt text, relations, order, settings, maps, files, custom rich-text tags, checks in CI, a changed URL, and common questions.
6 min readLocalization (i18n)
Give the site its locales, and mark each field that has a translation with `localized`. Content that is different in each language uses one collection for each language.
6 min readAdd Mica to an existing site
Move Astro content collections into Mica with mica import, keep other collections as they are, and keep the content in a separate repository.
4 min readContent in its own repository
Keep the content in a Git submodule of the website: the setup, the detached HEAD, the website build, and the self-hosted editor.
9 min readArchitecture
Understand how the model, repository, editor, and static build fit together.
Edit
Edit content
For editors: save and publish, changes that other editors see, discard, two saves at the same time, media, places on a map, translations, and how to undo a change.
5 min readEdit with an agent
Let a coding agent such as Claude Code read and change the content over MCP: on your own machine, or on a self-hosted Mica after you allow it.
3 min readPreview changes
How to see a change on the website: a link to its page, the live preview beside the editor, or a staging site.
Operate
Self-hosting
Run one Mica container for editors: repository token, sign-in, who may edit, drafts, the site build, backups, upgrades, and troubleshooting.
5 min readLarge files with Git LFS
Keep photos and other large media in Git LFS: the setup, the local editor, the self-hosted editor, the website build, the volume and the quotas of your host.
5 min readConfiguration
Every environment variable of the self-hosted image and the local editor, with its default.
12 min readSign in with Google
Let editors sign in to a self-hosted Mica with a Google account: the Google Cloud setup, the .env values, and the first sign-in.
8 min readOther sign-in providers
Use Dex, Microsoft Entra, Keycloak, Authentik, or ZITADEL with a self-hosted Mica, and set the groups claim.
8 min readSecurity
What Mica protects, who it trusts, the risks it accepts, and how to harden a self-hosted deployment. How to report a vulnerability.
3 min readAccessibility
The accessibility target of the editor, how Mica checks it, the known gaps, and how to report a problem.
5 min readVersions and support
What semantic versioning covers from 1.0, how a part goes away, which versions get fixes, how the image and @micacms/astro work together, and what Mica supports.
Reference
Command line
Every command and option of the local editor and of the self-hosted image, with the exit codes.
7 min read@micacms/astro
The loader options, the _mica metadata, the helpers for pages, the rich-text functions, the map component, the live preview, and the shape of images and relations.
7 min readFields
Every field builder of @micacms/core, its options, and what it stores in the repository.
2 min readHealth endpoints
What /health and /ready of a self-hosted Mica answer, and how to use them in a container platform.
No guide matches this filter.