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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.3.14.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.14.tar.gz
Algorithm Hash digest
SHA256 0abf416d2fef943373b06b5ce1fa79a366f4c29db96ad16411cc822179028ece
MD5 6938fbcc9bec53a1fb13f20e46e60347
BLAKE2b-256 f01cd62fec0923dba3c9dc7d5b6f82ef0b31b3a2dcdee6ef943b19fc08e8eda3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mystmd-1.3.14-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.14-py3-none-any.whl
Algorithm Hash digest
SHA256 0883fb0a9238d087b88109078279d1d748e973bf406f57301bb7a83e252dc68a
MD5 89a4e72e848e8e0de9bedaa1fda55cd0
BLAKE2b-256 29e5a6509a55e79973647ef6b04dce38546a0293a0f62d334cf4360922e3d5ed

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