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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.20.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.20.tar.gz
Algorithm Hash digest
SHA256 3645ca99aac5ff3e3788e492d53ec71ca687b4c2145d2ec01a632a5fc882059c
MD5 92a01d02940b8bf520230ca776516192
BLAKE2b-256 e36b78636ffdc6ed1599fa37742e6fbc13dec0a96670fe2bcba788a436d79d99

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.1.20-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.20-py3-none-any.whl
Algorithm Hash digest
SHA256 70d987573fde46b9280d3bdaa1cdeb01b3e2a1b05e52a495f5c93e8fc5b90bf4
MD5 38432b9ca8b9159b36abbe05199779ad
BLAKE2b-256 c16675bb895c828e36f2c79af03fd62c3eb87a41c18c97e819637653e804b884

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