Moving from a wiki
Spaces, parent pages, panels and attachments — and where each of them lives on disk.
The same ideas, as files
If your team is used to a hosted wiki, most habits carry over. The difference is where things live: in Kirbon, everything is a file in a folder you control.
| In a wiki | In Kirbon | On disk |
|---|---|---|
| Space | Documentation | The folder you open |
| Home page | Home | README.md at the top of the folder |
| Page tree | Sidebar ▸ Pages | Folders and .md files |
| Parent page | Page with child pages | team/README.md with pages next to it |
| Page title | The page’s first heading | # Your First Week |
| Attachments | Images and file chips | assets/<page>/… |
| Info, Note, Warning panels | Callouts | > [!NOTE], > [!WARNING] … |
| Page links | Links to pages and headings | Relative paths such as ../product/roadmap-2027.md |
| Page history | Your Git tool | git log |
Move your pages over
- Export to Markdown. Most wikis can export a space as Markdown, or as HTML that a converter turns into Markdown. Keep one
.mdfile per page. - Arrange the folders. Make a folder for each section and put its pages inside. Name the overview page of a section
README.md. - Check the titles. Kirbon takes a page’s title from its first
#heading. A page without one is titled after its file name. - Open the folder in Kirbon and look through the page tree. Broken links are underlined with a red dotted line and listed in Page Info.
- Fix callouts. Panels become GitHub alerts:
> [!NOTE],> [!TIP],> [!IMPORTANT],> [!WARNING]or> [!CAUTION]. You can change the type of any callout from its menu in Kirbon.
Panels and callouts
| Wiki panel | Kirbon callout | Markdown |
|---|---|---|
| Info | Note | > [!NOTE] |
| Tip | Tip | > [!TIP] |
| Note | Important | > [!IMPORTANT] |
| Warning | Warning | > [!WARNING] |
| Error | Caution | > [!CAUTION] |
Working together
Kirbon has no live co-editing. Teams share the folder through Git or a synced drive, and Kirbon handles changes when they arrive: a page without your edits reloads in place, and a page you’re editing pauses its autosave and offers Compare Versions…. See Using Kirbon with Git.
What stays the same for readers
Because Kirbon writes GitHub-flavoured Markdown with relative links and GitHub alerts, your pages read the same on GitHub or GitLab. Colleagues who don’t use Kirbon can open them in any editor.