Writing and editing

editor

The editor is organised in three levels: projects contain sections, and sections contain documents. Each maps directly onto the file system — a project or section is a folder, a document is a Markdown file.

Creating things

From a project, the actions panel offers New Document and New Section. Both ask only for a title. Creating a project writes a folder with an index.md inside it:

---
title: Docs Sandbox
type: index
---

Creating a document writes a Markdown file beside it:

---
uuid: 345caecb-050d-4f04-9656-237ed94d6ea4
title: Editor Tour
---

# Editor Tour

You never write uuid or type yourself — the editor maintains them. The fields you do control are title, sort, and tags, described in Repository layout.

The editor

The editor: title, tags field, and the formatting toolbar above the page body

The toolbar covers the usual formatting — paragraph styles, bold, italic, underline, strikethrough, inline code, lists, horizontal rules — plus links, file and image attachments, Table, and Diagram → Create diagram for a draw.io canvas. Text colour, highlight, and a Guide are on the right.

Tags sit above the toolbar as a comma-separated field. They are written straight into the document’s frontmatter and feed tag filters in search.

While you have unsaved work, an Unsaved changes badge appears above the toolbar. Save writes the file; Cancel discards.

Seeing the Markdown

The icon at the far right of the toolbar toggles the source view. It shows exactly what will be written to disk:

# Editor Tour

A short paragraph written in the WYSIWYG editor to see what lands on disk.

That is the whole point of the format. What the editor produces is ordinary Markdown a human would have typed — no wrapper elements, no HTML soup, and nothing that needs converting before another tool can read it.

Document actions

Opening a document gives you Edit, History, Move, Delete, and three exports — Markdown, PDF, and HTML. The same three exports exist at project level, so you can take a whole project out in one action.

History

History opens the revisions view for that document: preview, diff, or download an older version. Restoring writes the chosen version into your working tree, where you review and commit it with your own Git tooling — the editor does not quietly rewrite history behind you.

History comes from Git. Until the docs folder is a Git checkout, a document reports no recorded history, because nothing is recording it yet.

Where the settings live

Settings → Workspace holds the docs folder — the Git checkout DocuCommit reads and writes Markdown in — plus the Lucene search index directory and the listen port.

These values are stored in your OS application-config directory, deliberately outside any repo checkout, so configuring the editor never shows up in git status. The search index is likewise kept outside the docs folder, so it never lands in a commit.