Document editor

Markdown basics

Headings, lists, bold, links, code — Markdown core in three minutes.

Why Markdown

Kition uses CodeMirror 6 with Obsidian-style inline decorations — what you type is always plain .md, but the renderer collapses the syntax into clean styling as you go. Ten years from now, with or without Kition, your notes still open as readable Markdown anywhere.

The core idea: conventional characters mean formatting. A leading # is a heading, a leading - is a list item. No toolbar, no mouse, no flow interruption.

You write plain `.md`; the editor renders it live — the substrate stays text.

Tip

Want to peek at the raw syntax? Move the cursor into a line and its decorations unfold into bare Markdown, then collapse again when you leave — no separate "source vs. preview" mode to toggle.

Common syntax

# / ## / ### — H1 to H3 (up to H6 supported)
- / * — unordered list; nest with two spaces or a Tab
1. — ordered list; numbers re-flow automatically
bold / *italic* / ~~strike~~ / ` code `
[text](url) link / ![alt](path) image
> blockquote, nestable
--- horizontal rule on its own line
Code block: triple backticks with a language tag, e.g. ``` `ts ```

A complete example

markdown

# Monday standup

## Progress
- Finished analysis of the login page A/B test results
- Fixed the concurrency race in `auth/refresh-token`

## Risks
> The data migration script ran for 47 minutes on staging; production may need a scheduled maintenance window.

## Next steps
1. Draft the RFC
2. Sync with the @platform team
3. Finalize by Wednesday

---

Reference: [Migration design](https://example.com/rfc)

Kition extensions

Kition extends standard CommonMark / GFM with a handful of niceties. Every extension degrades gracefully — open the file in any other Markdown tool and the worst case is plain-text rendering, never data loss.

[[wikilink]] — link to another doc with alias and heading anchors
> [!TIP] — callout blocks, five flavors
$$math$$ — KaTeX inline or block math
``` `mermaid ``` — flowcharts, sequence diagrams, ER diagrams
![[Tables/projects]] — embed a table or one of its views
- [ ] / - [x] — task checkboxes, aggregable across the vault

Shortcuts and editor behavior

Cmd/Ctrl + B bold, Cmd/Ctrl + I italic
Paste a URL onto selected text — it auto-wraps as [text](url)
Enter on a list line continues the list; double-Enter exits
Tab indents the current list item, Shift + Tab outdents
Cmd/Ctrl + / toggles a comment on the current line (inside code blocks)

Common gotchas

Headings need a space after # — #title is ignored
Two trailing spaces + newline make a <br>; a plain newline stays in the same paragraph
To include a backtick in inline code, wrap with double backticks: ` code `
Punctuation hugging * can break emphasis in CJK text — leave a space to be safe

Wikilinks and backlinks

`[[Doc name]]` creates a link; the backlinks panel shows what references the current page.

Callout syntax

`> [!note]` form. Supports note / tip / warning / danger / success.