Guided tour

The tour is a small MyST project in docs/examples/tour/. Each page has Try this boxes that walk you through a feature in the editor.

Open it with the Codespaces or Binder badge on Get started, or locally:

npm run demo          # in the web editor
npm run demo:lab      # in JupyterLab
npm run demo:vscode   # in VS Code

Each opens a copy of the tour in a temporary folder, so your edits don’t touch the repository.

Start at index.md and follow the link under Next at the bottom of each page. The last two pages are for JupyterLab and VS Code. notebook.ipynb shows MyST in a notebook. github.md clones a second project into the workspace and pushes a change back to GitHub.

References, Preview, and Directives and roles explain each feature in more detail.