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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.38.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for mystmd-1.1.38.tar.gz
Algorithm Hash digest
SHA256 24fac7ac74e0290747978b10a09c44e25dabddc5a8ae92c00bade300df39cca2
MD5 f2c3932772c8071c73bf2c21591bfa33
BLAKE2b-256 87edf4a0ad12f5f13446008268a1f3057301161d891a9812888bc9e50a29fbf7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mystmd-1.1.38-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for mystmd-1.1.38-py3-none-any.whl
Algorithm Hash digest
SHA256 643897a9245a1a259385871439e1859e5d7234cf48c8308bb524779c6adfb4f9
MD5 672a3697f65b5e7a8ee62505a8c8dca8
BLAKE2b-256 df023f8ce55eb7bb441a2cb1dc517a473ca50eabe89f0eb6d062160ad8d9d85a

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