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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.18.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.18.tar.gz
Algorithm Hash digest
SHA256 22c5b41eb3d718ea7598514f87b0d558aaf7497d3a8338d353af0bb7ca979a48
MD5 2b310f7bc104a13859a6afd103f38a0c
BLAKE2b-256 5585fcaf9f0cd4b75d62b951302ebec00e882175f43d9d384c3c7b6d1a1c6439

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.1.18-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.18-py3-none-any.whl
Algorithm Hash digest
SHA256 8f1f4494d72082b9e0b93ad5eaa9976e862158b8c5a952a0d8beddcf9e11560f
MD5 bad12d24684ba7def6440a60920adb05
BLAKE2b-256 75fea43ccc36e2bf197e3dc5bc8876a6fa7d8d4f278e6dc69c487a74398ba1d9

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