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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.29.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.29.tar.gz
Algorithm Hash digest
SHA256 75f637a03573cc966c6c8f8346cf8dca4a9c5f688cef0c0c55d8a25251c32b70
MD5 73f17f74751fb248441b769e79c5b086
BLAKE2b-256 30a989b799090dbdbf9bc34f2336cc774385d776b8c1c8be4e067e12b03dc618

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mystmd-1.1.29-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.29-py3-none-any.whl
Algorithm Hash digest
SHA256 45cca8cfebd08f506f08db607cd0e08b9eedd1eafb8af4c25a593284ecf37f7d
MD5 e25469a0bcd0bd01506211ef6918f504
BLAKE2b-256 d4175c0597ed1b519ca4a0346a2fb0b0fc249304b566e8d3d2d3c89f0c487e59

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