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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mystmd-1.3.5.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for mystmd-1.3.5.tar.gz
Algorithm Hash digest
SHA256 f74346d6da3fe9d60acc5e52dc11916167261090c48e61628025fe37cf3f25c2
MD5 cc89522a6980d333f27ecc2fb81998ee
BLAKE2b-256 c3d0f7af99f69f6375101de5d3431f0a12053b9df44a2631d913f261d9f75e4f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for mystmd-1.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 fd5124f5616e3e96a5276af0f4bceeaef977c72cc2d684b78443e07870e90671
MD5 700d12608dcfd289f062c1df795b8ff1
BLAKE2b-256 cecc610f3e06b096a441cd941f84d0d7db756b7e10bc52eead36ad83c9fa5c3a

See more details on using hashes here.

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