Install the MyST Markdown Command Line Interface
Install the MyST CLI using your favourite package manager
To install the MyST CLI, choose your preferred package manager. If you do not know what a package manager is, it is recommended that you install MyST with mamba from conda-forge.
Install mamba (https://
🛠Then install mystmd from conda-forge:
mamba install -c conda-forge mystmd🛠Install mystmd:
pip install mystmd🛠Ensure mystmd is ready for use:
MyST needs node (https://nodejs.org) in order to run correctly. If node is not already installed, starting myst will prompt you to install it:
$ myst -v
Node.js (node) is required to run MyST, but could not be found.
Install Node.js in '/root/.local/share/myst/18.0.0'? (y/N): y
Attempting to install Node.js in /root/.local/share/myst/18.0.0 ...
Successfully installed Node.js 18.0.0
v1.3.4Installing Node.js Manually
The mystmd package on PyPI ships with the ability to install node (https://nodejs.org). If you would prefer to install NodeJS manually, see Installing NodeJS:
Ensure your node (https://nodejs.org) is up to date (>v18), see Installing NodeJS.
🛠Then install mystmd using npm, yarn or pnpm:
npm install -g mystmdThis will install myst globally (-g) on your system and add a link to the main CLI tool. To see if things worked, try checking the version with:
myst --versionThis command should print the current version of the package. If all is good, you can type myst again in your terminal and it will list the help with all of the options available to you.
Dependencies for and PDF¶
If you are exporting to with an open-source template specified (see all templates) or if you are creating a PDF you will need to install a version of LaTeX.
🛠Install mamba (https://
$ mamba --version
mamba 1.5.8
conda 24.7.1🛠Install texlive-core and latexmk from conda-forge:
$ mamba install -c conda-forge texlive-core latexmk
