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.1.26

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.1.26
File Size Uploaded Provenance Actions
mystmd-1.1.26.tar.gz 2.6 MB Without provenance Details for mystmd-1.1.26.tar.gz

Built distribution (wheel)

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

Total release size: 5.2 MB

Release files / mystmd-1.1.26.tar.gz

Download URL mystmd-1.1.26.tar.gz
Size 2.6 MB
Tags Source
SHA-256 checksum
How to use checksums
89a5d4ee3f8a1f385d04d2f40df0100c5adc38426ab67d0a0a3ad186e53f8e96
BLAKE2b-256 checksum
How to use checksums
25ed5a90eaaec98b2a29d5dbfadcdb991675d779624ea04ea0ab1b884222668a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.12

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

Download URL mystmd-1.1.26-py3-none-any.whl
Size 2.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
05d580e9753fb4c9278c0bfa82dde108aeb8dcf477cc6a3a81064c0ed48bf6c8
BLAKE2b-256 checksum
How to use checksums
a245e0dad74bedb9abba611f950a45c3e7795b04ed5bb509183123b22719c97d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.12

Security for mystmd 1.1.26

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.1.26 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