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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.41.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for mystmd-1.1.41.tar.gz
Algorithm Hash digest
SHA256 9099177627fc08a0dd9b1af92c73e3b176aee505a04d280e5314e08ee39fa749
MD5 04e554889d1e57900515880d24d84350
BLAKE2b-256 d97c820c8e878decd7aea7097a2d66df85741423870108325236f6618b3de2d0

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.1.41-py3-none-any.whl
  • Upload date:
  • Size: 2.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for mystmd-1.1.41-py3-none-any.whl
Algorithm Hash digest
SHA256 9c3807ec7f882ea03d384ed6c1008f6399917dc9ddcbc7094908a3234c306faf
MD5 b0f9d6add2e95cbae7317c142ddedc57
BLAKE2b-256 0477d483f941ecc38b3fc1d165cac19892426d3b4aa20bd39db606d3f661248e

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