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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.2.6.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for mystmd-1.2.6.tar.gz
Algorithm Hash digest
SHA256 b4758a8602a58e16b2779654548ebec8e1fc947712580b58e1143002347de80a
MD5 3be4b3784e0d6eb0b848bcff9d6255c9
BLAKE2b-256 746c77d26e16c46460ad4a931aa3c851239ff86a24edb947d93e9e40f64695c1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 0e71c9f1be998b5a27abb2d462333c8a03efcd5de64abbf5913719e3a87b9124
MD5 774d2077d84fe43221c4fae60193b842
BLAKE2b-256 5c23010a371aa570c51d8a45c3f273e7b80537f849cb8550ece00698e1689f04

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