Documentation

Documents

Everything you write in Meldoc lives inside a document — Markdown content with live preview, rich formatting, and links to other documents.

Document in editor view

There is no folder type

Every document can hold content and hold other documents. A page with children is what a folder would be, and it still has a body of its own, shown above the list of its children. So you never choose between making a page and making a container — you make a document and nest under it if you need to.

To nest, use Add child from a document’s More (⋮) menu, or drag an existing document onto another in the sidebar.

Create one

Select Create document (+) at the top of the document tree, or press N. You give it a name, and optionally an alias — a URL-friendly identifier, unique within the project, that Magic Links (Wiki Links), public URLs and the CLI all address the document by. Leave it empty and one is generated.

A new document is Published and visible straight away. If you want to work on it privately first, set its status to Draft in the Share popover before you start — see Document Workflow.

Create document dialog

The document tree in the sidebar shows your project’s structure. Click any document to open it, drag and drop to reorder or nest, or select the More (⋮) icon on a row for options like duplicate, move, and delete. Breadcrumbs at the top show your current path.

In this section

Document Editor — Write and format content in the Markdown editor.

Document Workflow — Manage draft and published states.

Document Visibility & Access Level — Control who can see and access your documents.

Version History — Read an earlier version, see what changed, and restore it.

Document Short Links — Copy a short, stable link to any document.

Supported Markdown Syntax — Full reference for supported Markdown syntax.

Magic Links (Wiki Links) — Link between documents with wiki-style syntax.

Keyboard Shortcuts — Speed up your writing with keyboard shortcuts.

Archiving Documents — Retire outdated documents without breaking their links.

Renaming & Redirects — Rename safely; old names keep redirecting.

Tree Filters & Sorting — Filter and sort the sidebar tree by any property or field.

Contributors and Co-authors — See who is credited with a document, and hide a name that does not belong.