Editing and preview

Choose the Markdown flavor#

Open a .md file and select the project’s flavor in Settings → Tools → Markdown Pro. Choose GFM for GitHub-style content, Markdown Extra for its table rules, or CommonMark/Standard Markdown when extensions are inappropriate. Obsidian vaults can select their own flavor automatically.

Try this short GFM document:

# Release checklist

- [ ] Review the documentation
- [ ] Verify the build

| Task | Owner |
| --- | --- |
| Documentation | Team |

Edit without rewriting the document#

Select prose to use the floating formatting toolbar. Toggle task checkboxes directly and insert list items with Enter; ordered lists renumber after edits, including nested items. In a table, use its toolbar or context menu to add, move, delete, or format rows and columns. Inspect alignment and escaped pipes after editing.

Keep source and preview together#

Choose disabled, bidirectional, editor-led, or preview-led scroll synchronization. Editor-led mode is useful while writing; preview-led mode suits reviewing a rendered document against the source. Preview updates preserve the reading position.

GFM rendering supports task lists, highlighted code, math, Mermaid, collapsible sections, local geographic data, and STL models. Use a language name on code fences for predictable highlighting and injection.

Review quality checks#

Use the IDE’s inspection feedback for missing titles, heading order, duplicate anchors, image descriptions, list consistency, code fences, and final newlines. Apply quick fixes individually and review the diff. An orphan-page warning is based on the configured documentation project, so configure that root before changing links to satisfy the inspection.