Configuration

Set up with AI

You can ask an AI assistant — Claude, ChatGPT, Gemini, Cursor, Copilot — to set a site up for Orbit. Orbit publishes a guide written for assistants, so they know exactly what to do: find the content, write orbit.config.yaml (with a content map for sites not built with Astro), and move words that are stuck in code into content files — without touching the design.

Ask your assistant

In a chat that can see your code (or browse the web), say:

Read https://orbitmarkdown.com/llms.txt and make my site Orbitable.

or

Follow https://orbitmarkdown.com/ai/orbitable.md to configure this site for Orbit.

The assistant should end with a summary: what editors can now change, what stays in code and why, and anything it left for you.

Make it a habit

  • Claude — save the Orbitable skill as .claude/skills/orbitable/SKILL.md in your project (or your home folder), then just say “make this site Orbitable”.

  • Cursor — save the rules file as .cursor/rules/orbitable.mdc.

  • Any editor — add this line to the top of orbit.config.yaml and VS Code (with the YAML extension) and others check the file as you type:

    # yaml-language-server: $schema=https://orbitmarkdown.com/schema/orbit.config.json

Check the result

Review the changes like any pull request — they should be a short orbit.config.yaml and small, targeted edits. Make sure the site still builds, then open it in Orbit and go to Site settings ▸ What Orbit edits: every section should be listed, and anything left out explained.

The guide, the JSON Schema and the llms.txt are public, so any assistant can read them.