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.
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:
Coming from Jupyter Book or Sphinx?
👋 We are glad you are here! 💚
There are many ways that mystmd
can be used with Jupyter Book and Sphinx. We recommend that you read background on mystmd
, which goes over how these projects overlap and work together!
- TL;DR
- Yes, you can use
mystmd
with your Jupyter Book!mystmd
can create scientific PDFs and can natively read the_toc.yml
as well as all of your existing MyST Markdown content and Jupyter Notebooks. - Yes,
mystmd
is compatible with intersphinx even though it is written in Javascript not Python! - Jupyter Book and
mystmd
have overlap in the ability to create online books like this one.mystmd
has some extra capabilities for cross-references, interactivity and performance.
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 & , Word, React, or JATS.
Using Sphinx or Python?
For integration with Sphinx, use the Python implementation for MyST or Jupyter Book, which can be found at:
Although many tools in the MyST Ecosystem follow the same conventions and specification, the following documentation refers only to the Javascript MyST Markdown CLI.
Premium IPTV Experience with line4k
Experience the ultimate entertainment with our premium IPTV service. Watch your favorite channels, movies, and sports events in stunning 4K quality. Enjoy seamless streaming with zero buffering and access to over 10,000+ channels worldwide.
