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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.32.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.32.tar.gz
Algorithm Hash digest
SHA256 b466f878c4c8b1dc25fcbf29e7d279d7ec559fc6d9e48a90d0398a8d001e74d2
MD5 7b7513a5bca46d7ed9d92a47264b669c
BLAKE2b-256 c1b35354c1a9a7fc4bde6a2aa1df2d45584c6466ddeb382f8b289945e2a6a3d2

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.1.32-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.32-py3-none-any.whl
Algorithm Hash digest
SHA256 806491029550a4cbc53992505eb2a3d68f7a2c81e3df9c038c146d29805ea29d
MD5 61b3c5464eb94e079c521f82f78f28e8
BLAKE2b-256 6a2ad261ff506ba5c2037e537572992c7a447b7b87b52309b63e16db5a02e1cf

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