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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.3.10.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.10.tar.gz
Algorithm Hash digest
SHA256 0016a6a7181b787bf4246f64923ed2cf871297c921ea957d4a5779a1544a5d5d
MD5 c8c8c20481699d57c50aabb1fcede2c2
BLAKE2b-256 57b2b27fd8081a3e2921b376391f7e01e37508cfc0abb68044c65a5e56ec90d3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mystmd-1.3.10-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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 718f7fa19a7bd8e2577b66be3dcbe3a45c7c53f201bb54e638c32435a3983dc0
MD5 e8e87c50ee6b106e05a5746d8bac8a47
BLAKE2b-256 2498b4ce709d7a7cc02f7755973e4395a184a756c9307303f7b3a2db043297b2

See more details on using hashes here.

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