Orbit MD

Configuration · orbit.config.yaml

Collection rules

Rules for each section (collection), under collections.<name> in orbit.config.yaml — or in Settings ▸ Collections.

  • collections.<name>.readOnly locks editing; canAdd (Settings: Add pages) widens or narrows “new pages”; bodyless hides the body editor (also inferred for data collections and empty-body docs).

  • collections.<name>.addTo / noAddTo (Settings: Allowed folders / Blocked folders) limit which folders take new pages. Each is a list of folder names relative to the collection; a folder includes everything inside it (archive also covers archive/2019), so there’s no /** to add. Use a path for a folder further down (2026/drafts). . means the top level only (pages in no folder) — set it here in the file; Settings doesn’t offer it. E.g. noAddTo: ["."] makes every new page go in a folder. List as many as you like (["archive", "drafts"]). Leave addTo out to allow every folder; noAddTo always wins. (Glob patterns such as */drafts work too.) A closed folder shows no new page / new folder icon (its existing pages stay editable), and a new page still follows the collection’s schema. You can set these in Settings ▸ Collections too. More, with examples: Folders that don’t take new pages.

  • collections.<name>.newFolders: true (Settings: Add folders) lets editors start a new sub-folder with their first page in it (a new folder icon appears on the section and its folders). Off by default because it can break your site: the folder becomes part of the page’s ID and URL, and a [slug] route (or any code expecting one-level IDs) can’t serve it. Make your routes ready first — a [...slug] route and example code are in Letting editors create folders. Folder names are slugged; addTo / noAddTo and the glob still apply (a *.md collection can’t take one). Also in Settings ▸ Collections.

  • collections.<name>.url (Settings: Address) is where each page of the section lives on the site, so the Page tab’s Preview ↗ / Live ↗ buttons open the page itself rather than the home page. Start it with /; {slug} is the page’s name (a page in its own folder — hello/index.md — takes the folder’s name) and {path} adds any sub-folders (2024/hello). A folder’s index page is the folder’s own address. Examples: /blog/{slug}, /docs/{path}/, /about for a fixed page. Leave it out when addresses come from something else (a title, a date) — the buttons then open the home page. The site addresses themselves are site.previewUrl / site.liveUrl (Settings ▸ General).

Orbit MD's Site settings, Collections tab: a row per section with tick boxes for Add pages, Add folders, Read-only and No body, and typing fields for Allowed and Blocked folders. The posts section allows 2026 and blocks 2026 / 07 and archive, shown as removable tags under the fields. Sections with no folders show their folder fields greyed out with the reason, e.g. No folders in this section yet, and pages, where adding is off, says Adding pages is off. A guide below explains each column.
Settings ▸ Collections — what editors can add in each section, and where.