Key Concepts

A few ideas that come up throughout Meldoc. Understanding these before you start will save you from surprises later.

Aliases

Every document can have an alias — a stable, human-readable identifier like getting-started or api-auth. Aliases power two things:

Linking between pages. Use [[alias]] syntax to create links that survive moves and renames. If you restructure your docs, links don’t break.

CLI sync. The CLI uses aliases to match local .meldoc.md files with their server counterparts. Without an alias, the CLI can’t track a document.

You can change an alias later. The old one is retired rather than dropped, so links written against it keep resolving — see Renaming & Redirects. Still worth picking a good one: a redirect works, but the address people copy and paste is the new one.

Workflow

Documents move through two states:

Draft — visible only to workspace members. Use drafts for work-in-progress content that isn’t ready for readers yet.

Published — finished, and now subject to a second question: who may read it. New documents start as published by default.

That second question is the access level, and it is a separate setting rather than a consequence of publishing. Left on Inherit from project it follows the project, which is what most documents want. Set explicitly, it wins over the project — so a document marked public inside a private project really is public. See Document Visibility & Access Level.

You can switch workflow states anytime from the editor toolbar. See Document Workflow for details.

Assets

Images and files in Meldoc are stored at the workspace level as Assets. All projects share the same asset pool — upload once, use anywhere. You can drag images into the web editor or reference them in Markdown with standard image syntax.

What’s next?

Quick Tour — Create your first workspace, project, and document in 5 minutes.

Documents — Deep dive into writing, editing, and organizing content.