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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.2.9.tar.gz
Algorithm Hash digest
SHA256 9cab0dc2b07c4a1c0f5a6bac72f6736b5bf2226dddc7faad076dc7ac93d28770
MD5 2e0b73618b095c0b8e6767b69b69a834
BLAKE2b-256 09850fb25318e3b4f07f1cb449db919ab4e6fb81f83014c5357bfea4517f70c6

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.2.9-py3-none-any.whl
Algorithm Hash digest
SHA256 55408477757f7d7d9f07db35e3e81e3d800e79c7df8c8d6b293250da02b56f2a
MD5 1c8758c479774a898a976b7a1b2c7a22
BLAKE2b-256 cdc7fcaf3092a7589cb0f8f70111c82608ff78cc15176077cf994ffa01638b5b

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