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

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.3.8.tar.gz
Algorithm Hash digest
SHA256 1d6f16e386e2847d51474c891e54d0cca94d628b806b028f1f90c99cf1186b00
MD5 3c4904f11ed4f55877a790a2f4e7df67
BLAKE2b-256 f81264fa856b7930e29dff68bb728d16c15a74e02dc434652d13076408740025

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mystmd-1.3.8-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.6

File hashes

Hashes for mystmd-1.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 1d0995d4ede7c7d72a5990829a6a1abc2d9309594267461462c29669b5674ba7
MD5 1b9d80d4ab0aeadc69d1911126714c59
BLAKE2b-256 a0a79783d345cd64bedaa2c3cb07dcb2e2f3acbb87d475049b16fc45aa74c53d

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