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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.3.4.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.4.tar.gz
Algorithm Hash digest
SHA256 a61122b2f6fb7705a1cf99c519c9093e14a637ac133719e53ef61acbd41749b7
MD5 fdf75cb1ec1510bb7d9b5cb2090bc0f9
BLAKE2b-256 b2a946430dec791d8e7d00c1c30f9961879aa83458189b035f910e42d6f6b3b4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mystmd-1.3.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 70e8ef30b17e7212f3995876832deed01e6887f6ee996325d401cf9570d83f76
MD5 43e9bef12af630f22d0c4c0425707fb5
BLAKE2b-256 8c9ed306ade612891a47da40e117703e85968e76653ac7885a5b113bca4087e6

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