Skip to main content

Command line tools for MyST Markdown

Project description

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mystmd-1.8.0.tar.gz (2.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mystmd-1.8.0-py3-none-any.whl (2.8 MB view details)

Uploaded Python 3

File details

Details for the file mystmd-1.8.0.tar.gz.

File metadata

  • Download URL: mystmd-1.8.0.tar.gz
  • Upload date:
  • Size: 2.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mystmd-1.8.0.tar.gz
Algorithm Hash digest
SHA256 1bbbb282e17ba7aef2ec2f8f7d0031d41d8f89dd9264578199e61c6487160dce
MD5 824735766fc4c15a3531cacb08b618b7
BLAKE2b-256 b1059045016d777b9289a2192b84bb06b604e62ffb1814dd0b409d6e07edf733

See more details on using hashes here.

Provenance

The following attestation bundles were made for mystmd-1.8.0.tar.gz:

Publisher: release.yml on jupyter-book/mystmd

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mystmd-1.8.0-py3-none-any.whl.

File metadata

  • Download URL: mystmd-1.8.0-py3-none-any.whl
  • Upload date:
  • Size: 2.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mystmd-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4df0957040172ebaec46825bd314ff7f158cae9950c58ce650dae03c3b633c5f
MD5 801c724b88c6d24a2ed6dc639f6c0211
BLAKE2b-256 eae54a03c21b6b5a48894339ab3a7c63ddedd220fb05819130b2e2efb2d8d553

See more details on using hashes here.

Provenance

The following attestation bundles were made for mystmd-1.8.0-py3-none-any.whl:

Publisher: release.yml on jupyter-book/mystmd

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page