Skip to article content

The documentation of MyST is inspired by the Diataxis Documentation Framework.

Build the MyST guide documentation locally

To build the MyST guide documentation:

  1. Clone this repository:

    git clone
  2. Install MyST Markdown by following these instructions

  3. Navigate to the docs folder:

    cd docs/
  4. Start a MyST server to preview the documentation:

    myst start

This will build the documentation locally so that you can preview what your changes will look like.

How this relates to the documentation at

The documentation in this repository serves the content that lives at

The full content and theme for is hosted at executablebooks/, which pulls in the content from this folder along with several other documentation sources into one place.

However, the documentation here can be built independently for previewing your changes.

The documentation theme infrastructure

The MyST website at is a custom MyST theme designed by the community in order to aggregate documentation from many locations into one website.

The custom theme is a Remix website and is deployed on Vercel.

It is an example of how to generate a custom application/site using MyST components. For example, is pulled from executablebooks/mystmd: /docs/, and is pulled from executablebooks/mystmd: /jtex/docs/. It also includes some custom applications like the Sandbox and MyST demo on the landing page.

It is not how most people build websites with MyST Markdown, but is a good “Advanced Use” example.

Where the theme is located

The MyST documentation uses a custom theme that inherits from a chain of base themes. Here’s a brief overview of where to look for things:

Modifying and releasing a theme

Below is a brief description for how modifications in a theme are released for public consumption.

  1. [dev facing] we make a bunch of changes to the theme, probably changing things in themes/book/*, themes/article/* and packages/*
  2. [dev facing] if there were changes in packages/* we release the @myst-theme/* packages (changesets based ci step)
  3. [dev facing] we then run make deploy-book and make deploy-article which builds and bundles each theme, making commits to the and repos.
  4. [user facing] at that point those latest bundle commits will be what is pulled by mystmd clients - people who already have those downloaded need to myst clean --all (as we don’t yet auto bump based on version changes, see #854 for updates).

Deploy previews for pull requests

We use the Netlify service to generate deploy previews of the mystmd documentation for all pull requests. These build only the mystmd guide (hosted at, not the entire website. They’re just used for convenience and review purposes.

Configuration for our Netlify build exists in the netlify.toml configuration file in the root of the repository.

Any team members can have Developer access to our shared Netlify account, and Steering Council members can have Owner access. If you’d like access, please ask a maintainer.

MyST MarkdownMyST Markdown
Community-driven tools for the future of technical communication and publication