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.3.17.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

mystmd-1.3.17-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.3.17.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for mystmd-1.3.17.tar.gz
Algorithm Hash digest
SHA256 8f7612703bb828201fea507dc02018032c5bebc6ebe244c8d4a0863e214c9efb
MD5 978736e69a4c46353f1c5c468b257201
BLAKE2b-256 94895d2c22724573a4885afa241946ea33ddbf4962725e804499ec62c7275af5

See more details on using hashes here.

Provenance

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

Publisher: GitHub
  • Repository: jupyter-book/mystmd
  • Workflow: release.yml
Attestations:
  • Statement type: https://in-toto.io/Statement/v1
    • Predicate type: https://docs.pypi.org/attestations/publish/v1
    • Subject name: mystmd-1.3.17.tar.gz
    • Subject digest: 8f7612703bb828201fea507dc02018032c5bebc6ebe244c8d4a0863e214c9efb
    • Transparency log index: 146586447
    • Transparency log integration time:

File details

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

File metadata

  • Download URL: mystmd-1.3.17-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for mystmd-1.3.17-py3-none-any.whl
Algorithm Hash digest
SHA256 42188d9474a3fe3421ddabbd7d107321e13bb96c6fc8d2d3ff376d6636918f10
MD5 4714e11b1264a244b2cd17f340c89033
BLAKE2b-256 74cf4a8a4714d75ce10ff52eb122efc7bb922117515b6fe1ca0a6f226d90a9bb

See more details on using hashes here.

Provenance

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

Publisher: GitHub
  • Repository: jupyter-book/mystmd
  • Workflow: release.yml
Attestations:
  • Statement type: https://in-toto.io/Statement/v1
    • Predicate type: https://docs.pypi.org/attestations/publish/v1
    • Subject name: mystmd-1.3.17-py3-none-any.whl
    • Subject digest: 42188d9474a3fe3421ddabbd7d107321e13bb96c6fc8d2d3ff376d6636918f10
    • Transparency log index: 146586448
    • Transparency log integration time:

Supported by

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