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

Uploaded Source

Built Distribution

mystmd-1.1.47-py3-none-any.whl (2.5 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.1.47.tar.gz
Algorithm Hash digest
SHA256 dd846e1a0f9899d34140c5f5f4f7e8978246f91e56a223091017b262ec4f5bed
MD5 43adc2cc6113e3338675a9aeaec5761f
BLAKE2b-256 9f16c175212db34f3950e3b3ba8caf3cc147a6637ea6204424d8b9b83bb6ad59

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.1.47-py3-none-any.whl
Algorithm Hash digest
SHA256 436a698b3d1e3818eda1f5059c45d364e42d7bda4f8231ee1c5a847f5acfb8e8
MD5 d8dbb7c58d7d79c0bd6164208849da97
BLAKE2b-256 510978857085dad5355f0df04fb80c51793efbeeefdc30de68ad31812d62871c

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