Installing MyST Command Line Tools

Objective

The goal of these quickstart tutorials are to get you up and running on your local computer 👩‍💻:

learn how to write MyST Markdown 🖊
export PDF, Word and $\LaTeX$ documents 📑
and create a website like this one 🌎

The tutorials will be brief on explaining MyST syntax, but we include an MyST Markdown Guide providing more depth on syntax and pointers to other pages.

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.

🛠 Throughout the tutorial, whenever you’re supposed to do something you will see a 🛠

Installing the MyST Markdown CLI 📦¶

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

🛠 Install the MyST command line tools:

PyPI

Conda / Mamba

NPM

🛠 Install node (https://nodejs.org), see Installing NodeJS:

node -v
>> v20.4.0

🛠 Then install mystmd:

pip install mystmd

🛠 Install node (https://nodejs.org), or through conda (see Installing NodeJS):

# Visit https://nodejs.org or:
conda install -c conda-forge 'nodejs>=20,<21'

Then install mystmd:

conda install mystmd -c conda-forge

If you have any problems, see installing MyST and or open an issue here. 🐛

Updating MyST

There are new releases of the MyST Markdown CLI every few weeks, to update to the latest version of myst, use:

PyPI

Conda / Mamba

NPM

pip install -U mystmd

To get the latest templates, clean your templates directory with:

myst clean --templates

This will remove the _build/templates directory, which will be re-downloaded with the latest templates when you run myst start or myst build.

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^[1], and navigate into the folder:

git clone https://github.com/executablebooks/mystmd-quickstart.git
cd mystmd-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$ !

MyST Markdown Guide 📖

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

MyST Markdown

Quickstart Tutorials

MyST Websites