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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.3.15.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.15.tar.gz
Algorithm Hash digest
SHA256 41d453a14e0785f77dc2ed252328a3a4c671ac1b7ef57d3cec18a83dad6e5665
MD5 15cdc9529033bb3e5f15a026d455d770
BLAKE2b-256 51e9f502ffaa1ad29f25246941aa98d2bcfe6acfbe6bef794ae8a1dccc701fdd

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.3.15-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.15-py3-none-any.whl
Algorithm Hash digest
SHA256 137ec490fb55d5dd198f162b6fdaa4b4d75bccba3821bfccae1bfa4a107ee7f2
MD5 3eb9391c115ef86b7c640ea631cbb684
BLAKE2b-256 1bab76c14d325dbb9476dea4b7d93ea113f215cada9b0da1ed2074eea9d3339f

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