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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.2.3.tar.gz
  • Upload date:
  • Size: 2.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for mystmd-1.2.3.tar.gz
Algorithm Hash digest
SHA256 ce5f18f553e4d5ca508f304408993cb9a0bcf4fcbc592c0f8885ff82ee9624e1
MD5 2059a1db9d6403a397b90782761e7fb0
BLAKE2b-256 156d92a49eddc220c6718356f17979288fd4f292cd94b900f9d4c0b6c6701b60

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for mystmd-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cc2b2381d67acc99d230148c566e11b4ed914c56b73d2e7a088e26d19ca8c9ae
MD5 60b3f4d8970388bffb60c40eefd125d3
BLAKE2b-256 a09642102bfe08237c47661dff58b8142b7310bbe43df0a8686f5a4c89dc9473

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