Skip to content

Wiki

Every page is a Markdown file in the wiki folder (docs/ unless Settings names another). The Wiki view (Ctrl+1) lists the pages on the left and shows the open one. Pages with a few sections get an outline, On this page, beside them when the window is wide enough.

  • E (or Edit) opens the editor, with a live preview next to the source; Toggle preview hides and shows it. Ctrl+S saves, Esc stops editing.
  • N (or the button above the page list) creates a page. Write / in its name to nest it: Architecture/Database becomes a subpage of Architecture.
  • Type [[ to link a task, a page or a file — see References. Type @ to mention someone and // to insert a date — see Writing pages.
  • Type / at the start of a line to insert math, a diagram, a callout, a table and other blocks — see Writing pages.
  • The editor is the same as in Code, with find and replace, several cursors and the other keys in Keyboard shortcuts.

A page’s file name is its title, with dashes for spaces: Getting-started.md is Getting started. The home page (Home.md unless Settings says otherwise) comes first in the list; the others are sorted by title.

Saved pages are ordinary changes: commit them in Changes, together with the code they describe. When the wiki lives on the Content branch, every save is committed there right away instead.

A page and a folder with the same name belong together: Guide.md is the page, Guide/ holds its subpages.

docs/
├── Home.md
├── Guide.md ← the "Guide" page
└── Guide/
├── Wiki.md ← subpages of "Guide"
└── Tasks.md

A folder without a matching page still shows up and lists its children. New subpage in a page’s … menu creates a page below it.

Move or rename… in the same menu moves a page together with its subpages. It also offers to update the links that would break: relative links and [[references]] to the moved pages from other pages, tasks and Markdown files, and relative links inside the moved pages. The dialog lists every change, and they happen together with the move — in one commit when the wiki lives on the Content branch. References by title keep working as long as the title stays; code blocks are left alone.

[[…]] links anything in the repository and shows what it points at, always up to date:

WriteShows
[[GENBEYA-12]]GENBEYA-12Virtualize long listsBacklog
[[Getting started]]Getting started
[[src/client/app/app.ts#L10-L20]]src/client/app/app.ts:10–20
[[GENBEYA-12|long lists]]GENBEYA-12long lists

![[src/client/app/app.ts#L1-L5]] on its own line embeds those lines of the file. References has the whole story: pages by title or path, line ranges, missing pages, task IDs in plain text, and what happens when things move.

  • Relative Markdown links work as on GitHub: [Tasks](Tasks.md), [Home](../Home.md#start-here). The .md may be left out.
  • Links into the code open the file in Code, links to task files open the task, web links open in your browser.
WriteGet
[TOC] or [[_TOC_]]A table of contents of the page
[SUBPAGES] or [[_TOSP_]]The pages below this one
> [!NOTE], [!TIP], [!IMPORTANT], [!WARNING], [!CAUTION]A callout
```mermaidA Mermaid diagram
```plantumlA PlantUML diagram
```ts (any language)Syntax highlighting
- [ ] and - [x]A checklist

Writing pages has more: math, code blocks with titles, line numbers and highlighted lines, foldable callouts, footnotes, keys and collapsible sections.

```mermaid
flowchart LR
write[Write Markdown] --> preview[Live preview]
```

checkout

content branch

Write Markdown

Live preview

Save

Where the wiki lives

Commit in Changes

Committed automatically

checkout

content branch

Write Markdown

Live preview

Save

Where the wiki lives

Commit in Changes

Committed automatically

Images stored in the repository render inline: ![Board](images/task-board.png), relative to the page. They belong to the wiki, so while the wiki lives on the Content branch, Genbeya loads them from there. Remote images are not loaded; they show as a link.