These pages explain what each part of the editor does and where its limits are.
Guided tour: try each feature in an example project.
References: completion, hover, and warnings for cross-references.
Find your way around: a MyST-aware page outline, and searching labels by name or title.
Preview: live preview in the editor, the fast and built previews, and how to move between preview and source.
Directives and roles: completion and highlighting for directives and roles.
VS Code: using MyST Author in VS Code, and what differs.
JupyterLab: using MyST Author in JupyterLab, and what differs.
Work with GitHub: pull a project from GitHub and push it back, from Codespaces, a JupyterHub, or Binder.
The layout¶
The toolbar has these buttons:
Files shows or hides the file list.
Open ⌘P opens a file by name. Cmd+P and Ctrl+P both work, on any system. Start with
@to jump to a label anywhere in the project, or#to jump within this page’s outline.Source shows plain Markdown.
Preview shows Markdown beside the preview pane.
Live, the default, renders the page inside the editor.
The open file’s name is in the middle of the toolbar, and the preview badge is on the right.
One file is open at a time. Changes save about 500 ms after you stop typing, and again when you close the tab.