Deploying MyST Markdown on Read the Docs

MyST Markdown is a set of open-source, community-driven tools designed for scientific communication, including a powerful authoring framework that supports blogs, online books, scientific papers, reports and journal articles.

Minimal configuration is required to build an existing MyST Markdown project on Read the Docs.

.readthedocs.yaml

 version: 2

 build:
   os: ubuntu-lts-latest
   tools:
     nodejs: "latest"
   jobs:
     install:
       # Install mystmd dependencies
       - npm install -g mystmd
     build:
       html:
         # Build the site
         - cd docs/ && myst build --html
       post_build:
         # Copy generated files into Read the Docs directory
         - mkdir --parents $READTHEDOCS_OUTPUT/html/
         - cp --recursive docs/_build/html/* $READTHEDOCS_OUTPUT/html/

Getting started

If you have an existing MyST Markdown project you want to host on Read the Docs, check out our Adding a documentation project guide.
If you’re new to MyST Markdown, check out the official MyST quickstart guide.

Example repository and demo

Example repository: https://github.com/readthedocs/test-builds/tree/mystmd
Demo: https://test-builds.readthedocs.io/en/mystmd/

Further reading

MyST Markdown documentation