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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.28.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.28.tar.gz
Algorithm Hash digest
SHA256 4a309f0ae7ce2eabf804b9625c224dfcdcfb3e507018c2496743c725cf62598f
MD5 969e71ba187f1b20f685cc8a079fd770
BLAKE2b-256 35fd8d14b9f120db6734d0bb17fcfc132ff289769442f4aff0536c0cf65668f9

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.1.28-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.28-py3-none-any.whl
Algorithm Hash digest
SHA256 11f20b77e2a49bcb54a605bc5dd609e459b0bd909fb0badb5f12629a907f25c8
MD5 a96d5a1a6d254ab602276ccc1798d236
BLAKE2b-256 2330ad36853e334cd26b31669b0f924353d3d8805a9467cbc8307036102eb5fc

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