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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.11.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.11.tar.gz
Algorithm Hash digest
SHA256 692e1058b9cbda7c9a57d2ee8036137bfbd8e469234ffd88bc8fefb649635740
MD5 d2ba32b1dbe7e2a22cbe35c4b6da8fe4
BLAKE2b-256 a4379a7729a28552ee1755cf63bae4fdc65ebc1ca7cbe180ff0a357946ec9f38

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.1.11-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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 3c38377b64e275590f10e6ec8c6c39d7352b8c65a1b1f0effd5806c4416b9f17
MD5 6cec28426f129c36f4387cf25c15c2cd
BLAKE2b-256 4f2572cefe1009a501eae329c8bb3c4a8096c60328655d194f374f4809bd81ba

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