Skip To Article

MyST is an ecosystem of open-source, community-driven tools designed to revolutionize scientific communication. Our powerful authoring framework supports blogs, online books, scientific papers, reports and journals articles.

Get Started With MyST πŸ‘©β€πŸ’»

Start here to get up and running with the myst command-line tools.

Cool MyST Features πŸͺ„ΒΆ

We think MyST is really cool, some of the features that we think stand out are highlighted below with links to places in the documentation where you can reproduce them!


πŸͺ„πŸ° Rabbit-hole links allow you to get information to your reader as fast as possible, and they can deep-dive all the way to computations, code and interactive figures. You can play with this demo yourself in Working with MyST Markdown.

πŸͺ„πŸ“Š Live graphs can be embedded directly in your documentation or articles with computation backed by Jupyter or JupyterLite – running locally, on Binder, or directly in your browser. Get up and running with Thebe in In-Browser Execution

πŸͺ„πŸͺ JupyterLab support for MyST comes with inline computations, support for ipywidgets, matplotlib sparklines, editable task-lists, rich frontmatter, and beautiful typography and other elements like dropdowns, grids and cards. Install jupyterlab-myst today!

πŸͺ„πŸ“œ Export to PDF is easy with MyST, and we support hundreds of different journals out of the box, see myst-templates! You can also export to Microsoft Word or even JATS, which is used in scientific publishing. See the Scientific Articles!


Quickstart TutorialsΒΆ

Check out the following tutorials for more step-by-step guides:

Project GoalsΒΆ

MyST is part of the Project Jupyter organization, and is an open-source, community-driven project to improve scientific communication, including integrations into Jupyter Notebooks and computational results.

Technical Goals

Architecture

The mystmd command line tool can be used to parse MyST Markdown and Jupyter Notebooks into an AST. This data can be saved as JSON, or rendered to a website (like this one!) or any number of formats including PDF & LaTeX\LaTeX, Word, React, or JATS.

FootnotesΒΆ
  1. If you aren’t familiar with git, it isn’t required for this tutorial, you can download the zip file with the contents from the quickstart repository.

  2. If port 3000 is in use on your machine, an open port will be used instead, follow the link provided in the terminal.

  3. By default the myst clean command doesn’t remove installed templates or cached web responses; however, the function can with a:
    myst clean --all, or
    myst clean --templates --cache.

    Before deleting any folders myst will confirm what is going to happen, or you can bypass this confirmation with the -y option. For example:

  4. If the server stopped, you can restart the server using myst start.

MyST MarkdownMyST Markdown
Community-driven tools for the future of technical communication and publication, part of Jupyter.