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

Uploaded Source

Built Distribution

mystmd-1.1.10-py3-none-any.whl (2.7 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.10.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for mystmd-1.1.10.tar.gz
Algorithm Hash digest
SHA256 be9c7b046ab41f0e1d29caf027d19ae7992dac4195f901cafe244e80b1426acc
MD5 9a9fa42ba549ae92dc4c406b865eada3
BLAKE2b-256 282686ba2cabdf590dee5a48120ac1cb05562d41be0edcce35def020adb5c974

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mystmd-1.1.10-py3-none-any.whl
  • Upload date:
  • Size: 2.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for mystmd-1.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 2a3da109163ed908ad061ed8cc5573acf20b06e7cb32b3e1e70a2de56d5ecde4
MD5 82f695879145ccf5ddd6412301e4cfcd
BLAKE2b-256 fda82dceac691efc87ed26e763f5a198b0f97fb810758a8c549863640d107462

See more details on using hashes here.

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