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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.12.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.12.tar.gz
Algorithm Hash digest
SHA256 8d1f37afd15b4725a477c1c7d2dd3e994c8be59b2f75a5d3a8c1412a44d3da32
MD5 1916ef3742b601d8a829092951c45366
BLAKE2b-256 a9eabd91975553b08d8f26f15df5b18f0012a5b61f8a4dd9363d9f346f33e104

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.1.12-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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 5d783e10388ef5d8957d68049cfc2b3c79d47ff7c8a3338bf5be21accb14086d
MD5 62e845c5cf8ee22ed29c554335b58f83
BLAKE2b-256 1faf87f43ef0a0d40eccf2449e6c292cbc6bb2c842ac8292a3499ff2809123e4

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