MyST Quickstart Tutorial

Installing MyST Command Line Tools

Work locally with MyST documents and notebooks


To follow along with this quickstart tutorial on your own computer, it is helpful if you have some familiarity with using the command line, as well as using a text editor and/or JupyterLab.

Additionally, you should have these programs installed:

If the node ecosystem is new to you, see our getting started guides for installing node.

šŸ›  Throughout the tutorial, whenever you're supposed to do something you will see a šŸ› 

#Installing the MyST CLI šŸ“¦

The myst-cli is a command line interface (CLI) that provides modern tooling for technical writing, reproducible science, and creating scientific & technical websites. To get started install myst-cli.

Check your node installation greater than version 16 (see Installing NodeJS):

node -v
>> v16.18.1

šŸ›  Install the MyST command line tools:

npm install -g myst-cli

If you have any problems, see installing MyST and or open an issue here. šŸ›

#Download example content

We provide an example project that includes a few simple markdown files and some Jupyter Notebooks. In it's initial state, the project is not a good example of how to use MyST, but through the course of the tutorials you will correct that by improving the metadata, adding export targets, and creating a website!

šŸ›  Download the example content, and navigate into the folder:

git clone
cd mystjs-quickstart

#Go through the tutorials šŸš€

You are well on your way to getting started with myst the tutorials are written to go through in order, however, you can also jump in

šŸ›  Choose a quickstart tutorial to go on a mystical journey! šŸƒ šŸŽ²

MyST Websites šŸŒŽ

Learn the basics of customizing a MyST Website, including sharing frontmatter between pages.

MyST Documents šŸ“‘

Learn the basics of MyST Markdown, and export to a Word document, PDF, and LaTeX\LaTeX!

MyST Markdown Guide šŸ“–

See an overview of MyST Markdown syntax with inline demos and examples.