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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.3.6.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.6.tar.gz
Algorithm Hash digest
SHA256 a68773939a591e756b3f257346f7c7b7b57d0aed45f04bccef17bccbc253ddc1
MD5 195fa285c92ac90652cecf2963107ad5
BLAKE2b-256 ffc09c374af9d64ec3d5c4df09852e91f6677304e2916330d6e97a3352f0e94f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mystmd-1.3.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a24f1b414892c3bcc68ddb3b0d18776cdf78fe4d0089e74a62e97eab2ba3fdf1
MD5 fbc52b4eecaad8e877dc82e5c498a2e0
BLAKE2b-256 2604160dcc78bdd2f28a2ff68c66cc95c779daec4bf3fce9930112b4f74464fd

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