Installing MyST Command Line Tools
Work locally with MyST documents and notebooks
#Prerequisites
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:
- Node.js version >=16.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[1], 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[2], and navigate into the folder:
git clone https://github.com/executablebooks/mystjs-quickstart.git
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 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.