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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.1.25.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.25.tar.gz
Algorithm Hash digest
SHA256 3d7a057de4ce218ba4391f710f36eb624c63386bfedb89742308ec42c245f5b8
MD5 c274bce31054a5ac6e66bea3a371f58b
BLAKE2b-256 7afe6c95246144e336e8f2304c9bcf25150e28843e4aacfede06373dd2f782bb

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.1.25-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.25-py3-none-any.whl
Algorithm Hash digest
SHA256 350cc778e783a2838403186614e6ce9de04307938edb435d659aef43bc6a1fd1
MD5 43d39b3ac7357a7698319e046dd4e25f
BLAKE2b-256 5f984c1bbac8d681d54db25aab9cbca885c8c03306c291df8d5ec587ec9d137f

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