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.
π 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
.
Prerequisites - Install Node
You should have these programs installed:
- Node.js version >=18.0.0
- Node Package Manager (npm) version >=7.0.0
- A code and notebook editor (VSCode is great, and we recommend Jupyter Lab for notebooks)
If the node ecosystem is new to you, see our getting started guides for installing node.
π Install the MyST command line tools:
π 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
π Install node
(https://nodejs.org), see Installing NodeJS
node -v
>> v20.4.0
π Install mystmd
using npm, yarn or pnpm:
npm install -g mystmd
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:
pip install -U mystmd
conda update mystmd -c conda-forge
npm update -g 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 myst
ical journey! π π²
Learn the basics of customizing a MyST Website, including sharing frontmatter between pages.
Learn the basics of MyST Markdown, and export to a Word document, PDF, and !
See an overview of MyST Markdown syntax with inline demos and examples.