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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.2.7.tar.gz
Algorithm Hash digest
SHA256 d053aaa4be7e750177870e718e20d9e5da41265fd8e7174b1f8242740a1283d5
MD5 3e3938da497a8a5a1545e1437261ed22
BLAKE2b-256 bfc33d4bce64fc9a3a856d0d0f07f69f19c55845f84fc7be8c27fea9b5e5213f

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mystmd-1.2.7-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for mystmd-1.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 4c94f80a9db3b05c0a931de703596c97e79cc2f2bf3be1e98d716f54206539f1
MD5 f223fd9db1c5f22474e147890523b2e5
BLAKE2b-256 bedf6e14b957647958f6d3b5e860924086fabe10e21b201735a9b5eaa558cda9

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