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

Uploaded Source

Built Distribution

mystmd-1.1.39-py3-none-any.whl (2.4 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.1.39.tar.gz
Algorithm Hash digest
SHA256 73ee20581ebee945b597a1597fad6dcc7fa2e402e293e7d99286dadf80a1f17a
MD5 dad94c097e2b5de4f1771af42b043374
BLAKE2b-256 559304c26b4db973dc46f1bcacabad67757f46e737b121f30a4aa960a2d87d46

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.1.39-py3-none-any.whl
Algorithm Hash digest
SHA256 3088a73b79af2c03fc10cbdf41a26579cb32f0740feba8e0be913f3b6101aa71
MD5 2211ff62c8e03831f8937610b169c39b
BLAKE2b-256 68230aa33e6c026552106963f8487ea9ef46b2f2ab66a95807f78f5cbe698297

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