For the complete documentation index, see llms.txt. This page is also available as Markdown.

Working with Markdown and MyST

Markdown and MyST are lightweight markup formats with a Visual mode for word-processor-style editing, alongside raw Code mode.

Markdown (.md) and MyST (.myst) are lightweight markup formats. Unlike LaTeX and Typst, they have a Visual mode (a structured, word-processor-style view) as well as Code (raw source).

What you get

The block editor

In Visual mode, Markdown and MyST use a block-based editor. Type / at the start of a line to open a menu of blocks you can insert: headings, lists, tables, images, code blocks, and more, without remembering the underlying Markdown syntax.

Slash commands are a Visual-mode feature. In Code mode you're editing raw source, so / just inserts the character.

Things to know

  • Kanban boards (.kanban) and timelines (.timeline) are MyST-based files under the hood, but they open in their own dedicated board view rather than as editable Markdown. See Kanban and timeline boards.

  • MyST supports the same citation and image syntax as Markdown, plus additional scientific-writing directives.

Next steps

Last updated

Was this helpful?