Skip to content
Documentation

Working with Documents

updated

Everything you need for day-to-day writing in Meldoc: creating documents, the editor, files, links, comments and finding your way around the tree.

Editor interface

Create a document

Select Create document (+) at the top of the tree, or press N. Give it a Title and, optionally, an Alias — lowercase letters, digits and hyphens, unique within the project. The alias is how Magic Links (Wiki Links), public URLs and the CLI address the document; leave it empty and one is generated.

A new document is Published straight away. To work on it privately first, set it to Draft — see Document Workflow.

There is no folder type: any document can have children. Use Add child from a document’s More (⋮) menu, or drag one document onto another in the sidebar.

Write

The editor is a single live-preview pane: Markdown renders as you type and saves automatically. Select text for the formatting toolbar, including AI, Link, Magic Link and Comment. Press Space on an empty line to open the AI assistant. See Supported Markdown Syntax for the full syntax.

A locked document can’t be edited in the web editor — use it for pages maintained only through the CLI or a repository sync. Toggle it on the Info tab of the right sidebar.

Images, videos and files

Drag a file into the editor, or insert an image block and choose Upload or From library. Local videos (MP4, WebM, MOV) work the same way; YouTube and Vimeo links written as image syntax become embedded players.

Every upload goes to the workspace asset library, shared by all projects — browse it in the Assets tab on the workspace Overview. Supported formats: PNG, JPG, GIF, WebP, SVG, MP4, WebM, MOV, PDF, TXT, Markdown, CSV, JSON, XML, YAML, HTML. Deleting a document doesn’t delete its assets, and deleting an asset breaks the documents that use it. Storage limits depend on your Plans & Billing. For the CLI, see Working with Assets.

Copy link gives a short link like app.meldoc.io/d/XEq2iGMl. It survives renames and moves, and requires sign-in. To share outside your team, use a public link instead — see Document Visibility & Access Level.

Comments

Select text and choose Comment (Ctrl/Cmd+Alt+M), or comment on the whole document from the Comments tab in the right sidebar. A comment follows its passage when the text is edited and never changes the document itself.

Contributors

The Contributors list in the right sidebar shows who is credited with a document — Meldoc members and the authors of git commits that reached it through the CLI or a repository sync. It’s a credit only, with no access attached. Link git identities to members in Team.

Find documents in the tree

Use the filter icon at the top of the sidebar to filter by any property or Custom Fields and sort the results. For full-text search, see Search & AI answers.

Keyboard shortcuts

Standard formatting shortcuts work as expected (Ctrl/Cmd+B, I, Z…). Headings are Ctrl/Cmd+Alt+1–6. In Version History, ← and → step between versions and Esc returns to the live document.