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

Uploaded Source

Built Distribution

mystmd-1.1.22-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.22.tar.gz
  • Upload date:
  • Size: 2.6 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.22.tar.gz
Algorithm Hash digest
SHA256 78268f93d45da017647a1f37bcf23eb03c274cc2131f4b71ea7a7cfc258a8bc0
MD5 748d95872c5019499858da260c1910e8
BLAKE2b-256 41de94e6a2ad32705ecb18125f42bf9340303f4872a1317aa0ca25217d29d0a1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mystmd-1.1.22-py3-none-any.whl
  • Upload date:
  • Size: 2.6 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.22-py3-none-any.whl
Algorithm Hash digest
SHA256 987d8ae8a99173a7d97191e1348a426488015c19d3e9ad860af539188f50714e
MD5 5b621a51e70fb07f71a2f94dddb6625c
BLAKE2b-256 22befb808c7d8938beb294159a80590d73d1b437dd23c3b016d70b98c5a73ccc

See more details on using hashes here.

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