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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.2.5.tar.gz
Algorithm Hash digest
SHA256 0331ec05eaeb51054165ae5b148e7ba3e926a00cf70d587945fb5325071e1228
MD5 18ef5a01e4930e410a65da1bc4055fcf
BLAKE2b-256 15f2b668357bca0506bb54ea7c070d88e583ce20749e9c1623b0a4f149eab3c3

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.2.5-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.3

File hashes

Hashes for mystmd-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 93906e0f75cc71e170cf12bf57f54d177fb2259be6396951e72f95b458f72066
MD5 15a62bf061e0bb95e4f922973f66b12a
BLAKE2b-256 75f163dcbc8f84000086ac1fc7bcd20a608891be5b1a0b9b6789a30c10ee3a06

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