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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.1.43.tar.gz
Algorithm Hash digest
SHA256 b7ada8f2b0c824febfcda39a4a1d375d2d84c1ca79c46f3f9b5f8d04e27e7aef
MD5 ec7fa6bb2e190f5d6ce9bc53cbc0e309
BLAKE2b-256 a4d8226f74844b93f01841c6146a266f96d73ae5698610f923c4f561676d3c2a

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.1.43-py3-none-any.whl
  • Upload date:
  • Size: 2.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for mystmd-1.1.43-py3-none-any.whl
Algorithm Hash digest
SHA256 3082a6536eb9e2cacee14a79abe8eabf67100e1bc76acb06c7100cb8d75ee383
MD5 3d33a66e10b590e6a64a857dfdd39238
BLAKE2b-256 52f4f45d574d1ac9545f357ebfb80776221a748332110566f233aec9de97010d

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