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

Uploaded Source

Built Distribution

mystmd-1.1.16-py3-none-any.whl (2.5 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.16.tar.gz
  • Upload date:
  • Size: 2.5 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.16.tar.gz
Algorithm Hash digest
SHA256 1dc98656d5930a0d3b15d1c600ddc16586417169b9bba03d02c816440530daad
MD5 280346d8ccceb1633f7a582469f10bc8
BLAKE2b-256 228a200bbd6a41b81f4ec4991a84b7cb14ef3d744ede3cabbf20fe13af45b16e

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.1.16-py3-none-any.whl
  • Upload date:
  • Size: 2.5 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.16-py3-none-any.whl
Algorithm Hash digest
SHA256 c2ae3aa13dfc6506a6928144711ff0f56ae80deae8c16db2d60f31a3d6c99137
MD5 b635eb58446267a89287d30aeceaa718
BLAKE2b-256 c0a3e5e49afd53b75dd03120f38185315ebabdaa1be0bc745666338262a7bb8e

See more details on using hashes here.

Provenance

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