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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.3.16.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.16.tar.gz
Algorithm Hash digest
SHA256 73a6e450584ca2d246c7d861233f09875bf5471717c10ab3a9f77f0e4d512950
MD5 ab27316b7b592976c38469418eb6e03e
BLAKE2b-256 fddd76a9a660adea63c00e34f0a067e804b9a6518ae1d4d97582b0b00f80eae0

See more details on using hashes here.

Provenance

The following attestation bundles were made for mystmd-1.3.16.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.16.tar.gz
    • Subject digest: 73a6e450584ca2d246c7d861233f09875bf5471717c10ab3a9f77f0e4d512950
    • Transparency log index: 145230971
    • Transparency log integration time:

File details

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

File metadata

  • Download URL: mystmd-1.3.16-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.16-py3-none-any.whl
Algorithm Hash digest
SHA256 c4cfdcaf0a4858bcd9ffbf82ae1a2eedcc6621e29c0ea49b3c1e173b82e41e8f
MD5 a23663cd5374f63db389bbf7496d0a99
BLAKE2b-256 ee664a77dc46d604fde901a9807457e336fa97cff9e566c1d2d9d0f3218f4b19

See more details on using hashes here.

Provenance

The following attestation bundles were made for mystmd-1.3.16-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.16-py3-none-any.whl
    • Subject digest: c4cfdcaf0a4858bcd9ffbf82ae1a2eedcc6621e29c0ea49b3c1e173b82e41e8f
    • Transparency log index: 145230972
    • 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