- Notifications
You must be signed in to change notification settings - Fork89
Command line tools for working with MyST Markdown.
License
jupyter-book/mystmd
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
mystmd 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 journals articles.
Note
Themystmd project is inbeta. It is being used to explore a full MyST implementation and will change significantly and rapidly.The project is being developed by a small team of people on the Executable Books Project, and may make rapid decisions without fully public/inclusive discussion.We will continue to update this documentation as the project stabilizes.
Themystmd project provides a command line tool (mystmd) for working with MyST Markdown projects.
- Provides functionality for cross-referencing, external structured links, and scientific citations
- Translate and render MyST Markdown into:
- HTML for static websites, and modern React for interactive websites (like this website!)
- PDFs and LaTeX documents, with specific templates for over 400 journals
- Microsoft Word export
- Parse MyST into a standardized AST, that follows the MyST Markdown Spec
See thedocumentation.
Ensure that you have an updated version of Node installed (https://nodejs.org/):
node -v>> v20.4.0The MyST Markdown CLI is available through NPM, PyPI and Conda:
# Using npm, yarn, or pnpmnpm install -g mystmd# Or using PyPIpip install mystmd# Or using Conda / Mambaconda install mystmd -c conda-forge
Usage:
myst initmyst startmyst build my-doc.md --tex
Seethe Contribution Guide for information on setting up a development environment.
As of v1.0.0 this package isESM only.
About
Command line tools for working with MyST Markdown.