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

This version

1.3.2

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.3.2.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for mystmd-1.3.2.tar.gz
Algorithm Hash digest
SHA256 b715ecc01b6a9908feaf8424a0f98ecf0002cc4b5abdb9cd6f925b96f975d4ac
MD5 a6ed2343e00b9465acef463cbb25daba
BLAKE2b-256 1dc3df98dea05b0cd6d019246ef75cf5170744934b850e09d7a91fb602541246

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 fd316a559884cc22b8dbb8603a23c8a3e8f1fa6fbb085f73aedcbfc72a1fadd0
MD5 76cbb11283415069984a9ef3f76ee226
BLAKE2b-256 68b316323cdb30ab8c5949bf370a269c5955738b49171c02c3d80d5c11cdd7eb

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