# Wymark

> Wymark is a local-first markdown editor with review built in: a WYSIWYG and a raw view of the same file on disk, an always-on diff of every change against a baseline you control (accept and reject per change, whether the edit came from a commit, a saved version, another person, or a tool writing the file), and comments stored in the file itself as `<!--wymark:-->` markers.

Every documentation page is also available as raw markdown at the same URL with `/index.md` appended.

## Docs

- [Wymark documentation](/docs/index.md): What Wymark is and how its review model, comments, and file contract work.
- [Getting started](/docs/guide/getting-started/index.md): Requirements, installing the beta, what the first launch shows, opening your files, and how Wymark keeps itself up to date.
- [Exporting to Word and PDF](/docs/guide/exporting/index.md): File > Export: Word with real comments and track changes, PDF, what carries across, what falls back to plain insert-and-delete, and what to check before you send.
- [Changes from outside Wymark](/docs/guide/changes-from-outside/index.md): Three ways text from somewhere else reaches your document as changes to review: paste it as incoming, let a tool edit the file, or, later, an MCP server.
- [AI sidecar: letting a tool see the changes](/docs/guide/ai-sidecar/index.md): The AI sidecar is a file that lets a tool editing your document see the changes as Wymark shows them: how to turn it on, what it shows, and the optional HTML comment that points a tool to it.
- [Try a review](/docs/concepts/try-a-review/index.md): A live review in the browser: accept or reject six real changes and watch the Source and Formatted views follow.
- [Review: baseline, accept and reject, versions](/docs/concepts/review/index.md): Wymark's always-on review model: the working baseline, accepting and rejecting changes, and named versions.
- [Comparing against git and past versions](/docs/concepts/git/index.md): The vs … menu: measure your document against a commit, a saved version, or an anchor you've since moved past -- read-only, and gone the moment you leave the repository.
- [Comments that live in your file](/docs/concepts/comments/index.md): Wymark comments are plain HTML comment markers stored in your markdown file: anchored, threaded, authored, and legible to any tool or AI.
- [Keyboard shortcuts](/docs/reference/keyboard-shortcuts/index.md): Every keyboard shortcut in Wymark, grouped the way the in-app reference groups them.
- [Markdown support](/docs/reference/markdown/index.md): The markdown Wymark reads and writes: GitHub Flavored Markdown with footnotes and math, UTF-8 only, and an edit that changes only the part you edited.
- [The editor](/docs/reference/editor/index.md): The two views, Pure mode, the formatting toolbar, selecting and copying, undo, paste, and the settings that change how the document is shown.
- [Text](/docs/reference/text/index.md): Headings, bold and italic, line breaks, escapes and math: the syntax, what Wymark writes to the file, and how each behaves while you type.
- [Lists, tables and blocks](/docs/reference/lists-tables-blocks/index.md): Lists, tables, quotes and alerts, code blocks and dividers: the syntax, what Wymark writes to the file, and how each behaves while you edit.
- [Links, footnotes and pictures](/docs/reference/links-footnotes-pictures/index.md): Links, heading links, footnotes and pictures: the syntax, what Wymark writes to the file, and how each behaves while you edit.
- [Diagrams](/docs/reference/diagrams/index.md): Write a mermaid code fence and Wymark draws it. The same fence renders on GitHub, the styling travels inside the file, and a changed diagram reviews like any other code block.
- [Drawings](/docs/reference/drawings/index.md): Sketch with Excalidraw inside your document. The drawing is a plain PNG in your assets folder that opens back up as editable strokes -- here, on excalidraw.com, or in VS Code.
- [HTML](/docs/reference/html/index.md): The HTML tags the Formatted view draws, the same ones github.com renders; how the tags hide and show; and what is shown as source instead.
- [History bundles (.mdh)](/docs/reference/history-bundles/index.md): The .mdh file: a zip of timestamped markdown files, so you can send a document together with its version history. No manifest, nothing proprietary.
- [Privacy: what leaves your machine](/docs/reference/privacy/index.md): Everything Wymark sends over the network, everything it writes beside your files, and everything it deliberately does not do.
- [Why the diff is always correct, but not always pretty](/docs/how-it-works/diff/index.md): The design trade-off behind Wymark's review engine: an always-on, line-based diff that never lies, at the cost of sometimes telling the story coarsely.
- [Why comments live in the file](/docs/how-it-works/comments/index.md): The design decision behind Wymark's comments: plain HTML comment markers inside the markdown, not a database or a sidecar, and what that costs.
- [Comment marker syntax](/docs/how-it-works/markers/index.md): The exact format of Wymark's in-file comment markers: payload grammar, threading, pairing rules, and multi-line bodies.
- [Why a history bundle is a zip of markdown files](/docs/how-it-works/history-bundles/index.md): The reasoning behind the .mdh format: it mirrors how Wymark already stores versions, it is the smallest container that carries a document with its history, and nothing in it is Wymark-only.
- [For AI agents](/docs/agents/index.md): How an AI agent works with a markdown file managed by Wymark: read the live diff from the review sidecar and the comments in the file, edit the file freely, preserve comment markers, reply in place.