Orbit MD

Publishing

Launch checklist

Before you hand a site to editors, run down this list.

Required

  • astro in package.json.
  • A content config at a supported path; for Astro 6/7, z from astro/zod (see Astro versions).
  • Editable content is Markdown/MDX in content collections under src/content/ (see What Orbit edits).
  • Schemas use enums, image(), and .optional() / .default() thoughtfully (see The editor form).
  • Assets under assetsDir (default src/assets).

Optional — only if you use the feature

  • orbit.config.yaml at the repo root for branches, snippets, data files, collection overrides, components, and branding (see orbit.config.yaml).
  • MDX components — @astrojs/mdx installed and each component declared under components: (see MDX components).
  • Editable data — JSON files listed under data: (see Editable data files).
  • Snippets — src/content/snippets/ exists and the right mode is set (snippets.compileOnSave; see Images & snippets).

Publishing & branding

  • A testing branch (e.g. preview) under branches.default, and branches.live set to your live branch (default main) (see Branches & publishing).
  • The live branch protected on GitHub, with your approvers on the ruleset’s bypass list and editors given Write access (see Setting up your GitHub repository).
  • (Optional) site.previewUrl / site.liveUrl so Orbit links to the built testing and live sites.
  • A favicon at a conventional path, or site.favicon set.

That’s it — open the repo and the editing form builds itself from your schema.