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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.3.9.tar.gz
Algorithm Hash digest
SHA256 c7951c1f7ef3c124e143e2ce3b422212dfe395b95a5b7070070edc298a7e3a24
MD5 c45130d9359af6553349feac38650df9
BLAKE2b-256 831195fab98bbc24c2a61c7057e01c2e05abe414c08633084d75d6c52e1493f1

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.3.9-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.6

File hashes

Hashes for mystmd-1.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 4e00381f86a2f620c3a0777fe039f07c33add634e1c8e02d87ea813412cea223
MD5 96381318912b08378aecdb0351bbfd18
BLAKE2b-256 558f20a0d5e3b9ea46466b206707768508c338031b9f30a40a05a2fb957bc4e7

See more details on using hashes here.

Provenance

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