Skip to content

Files Kirbon creates

Pages, attachments and the optional .pages file — and everything Kirbon keeps on your Mac instead.

In your folder

Kirbon writes only what you’d expect to find in a documentation folder:

WhatWhereWhen
Pages.md files, named from their titlesWhen you create a page (named once, when you first give it a title)
SectionsFolders with a README.mdNew Section…, or a page’s first child page
Images and filesassets/<page>/ at the top of the folderWhen you add them to a page
Page orderA .pages file in that folderOnly when you reorder pages by hand

That’s all. Kirbon never writes metadata into your pages, never renames a file because you edited its title, and never deletes attachments when you remove them from a page.

The .pages file

A plain text file with one name per line — a file or folder in the same folder. Names not listed follow the listed ones alphabetically; lines starting with # are ignored. Delete it and the folder goes back to alphabetical order.

launch-plan-orbit-3-0.md
roadmap-2027.md
pricing-and-plans.md
customer-interviews.md

On your Mac

Everything about how you look at your documentation stays on your Mac, outside the folder — so it never shows up in Git:

  • open windows and tabs, their pages, views and scroll positions;
  • Starred pages;
  • Page Width choices for wide tables, outline collapse state, code line numbers;
  • Files & Attachments settings for each documentation folder;
  • the list of recent folders and Kirbon’s permission to open them.

In the Trash

Kirbon moves things to the system Trash rather than deleting them: pages you move to the Trash, and the copy of a file kept before it is replaced (for example, by Replace Disk Version with Mine…). You can put them back from the Trash.