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.3

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.3.3.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.3.tar.gz
Algorithm Hash digest
SHA256 fb8ff87f415147ed0dd02ab8f41589772c4ea741250b61b75b85f9fb7e426d83
MD5 9b4ff9427255a4dc97385d1ff620b90e
BLAKE2b-256 64c186dc3523a42937987f3f3fcc044d6c9b703bc8cdc5e77c979cecd7efc87f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mystmd-1.3.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fa1e02c014380ee8baa56190835bb15b654c9fb32d437d093ee1968927dc0e7e
MD5 80c26289ad90c29028de582b4a15e122
BLAKE2b-256 103c0f07fe43596496571f6eeb612d07cf3ee28153f9af31945b9313a1445abd

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