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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.3.11.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.11.tar.gz
Algorithm Hash digest
SHA256 7cacc3fdceabfe6e7b7a4152c4e3319a5be54453f83b460fb2b580e29313f1d8
MD5 9399d1a62fa21d2892ac2f2dfe4a7692
BLAKE2b-256 0a63268d689de9043edd6f64145ab7361da7b778621c4c5f03a710cec6a0abca

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mystmd-1.3.11-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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 c778a41b9971a7f342dc1825d5c077d0831f8a940ef468621176b7007cf908b8
MD5 d78c13d00f99393bd5b564442cb9180e
BLAKE2b-256 ff92083cf59366bcc6dad612feae36ba7ca3aba1ccc8e53a3d17bbe3b878c337

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