Skip to main content

MyST Markdown Command Line Interface, mystmd

MIT License CI

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 The mystmd project is in beta. 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.

Overview

The mystmd 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 the documentation.

Get Started

The MyST Markdown CLI is available through PyPI:

pip install mystmd
myst init
myst build my-doc.md --tex

and Conda:

conda config --add channels conda-forge
conda config --set channel_priority strict
conda install mystmd
myst init
myst build my-doc.md --tex

Metadata

Release files for mystmd 1.3.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mystmd 1.3.4
File Size Uploaded Provenance Actions
mystmd-1.3.4.tar.gz 2.6 MB Without provenance Details for mystmd-1.3.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mystmd 1.3.4
File Interpreter ABI Platform Actions
mystmd-1.3.4-py3-none-any.whl Python 3 none any Details for mystmd-1.3.4-py3-none-any.whl

Total release size: 5.2 MB

Release files / mystmd-1.3.4.tar.gz

Download URL mystmd-1.3.4.tar.gz
Size 2.6 MB
Tags Source
SHA-256 checksum
How to use checksums
a61122b2f6fb7705a1cf99c519c9093e14a637ac133719e53ef61acbd41749b7
BLAKE2b-256 checksum
How to use checksums
b2a946430dec791d8e7d00c1c30f9961879aa83458189b035f910e42d6f6b3b4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.5

Release files / mystmd-1.3.4-py3-none-any.whl

Download URL mystmd-1.3.4-py3-none-any.whl
Size 2.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
70e8ef30b17e7212f3995876832deed01e6887f6ee996325d401cf9570d83f76
BLAKE2b-256 checksum
How to use checksums
8c9ed306ade612891a47da40e117703e85968e76653ac7885a5b113bca4087e6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.0 CPython/3.12.5

Security for mystmd 1.3.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.3.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page