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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.21.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.21.tar.gz
Algorithm Hash digest
SHA256 5b5ee4b4a65267dd2243f4ed3c302821f53c766ac9c147f52a61c26dc624dcc5
MD5 5c03f5adbe5bd4a0d889be2954bbe060
BLAKE2b-256 73f8b67d7f87c832cd6481fb782e20aa6a4ba91418fafc9d81d128e26b870f03

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.1.21-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.21-py3-none-any.whl
Algorithm Hash digest
SHA256 cff4b7d60b89dde12dc53c3f38677cbbdaadf1a136ec794987d571ac25ddd760
MD5 0a9c22716b00afa870c3a8d7b6121b0a
BLAKE2b-256 08dab113884e26d8f3f53dc6f5dbfbeb2a67501bf8821f00b8870f3fb8f2eadf

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