Command line tools for MyST Markdown
Project description
MyST Markdown Command Line Interface, mystmd
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
mystmdproject 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
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
Built Distribution
File details
Details for the file mystmd-1.3.1.tar.gz.
File metadata
- Download URL: mystmd-1.3.1.tar.gz
- Upload date:
- Size: 2.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.0 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6a85b76858e231fc708ddea6da49df942134ae9acbbd0bb114b447e788c67439 |
|
| MD5 | 838b539b52bc920ad48fc6d79fb672d6 |
|
| BLAKE2b-256 | 1a29ec318e5d05a5074f6a25a0fe803e54abeb0b98bac985ff8adde539f6f942 |
File details
Details for the file mystmd-1.3.1-py3-none-any.whl.
File metadata
- Download URL: mystmd-1.3.1-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.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 44cd99afc2ee6cad2d71ccb8b02e4e78c8363ec06c914e032996be5dcc5a8c05 |
|
| MD5 | d2c0e94d6d610703efe096dc3f7d0b4f |
|
| BLAKE2b-256 | e10dcfb77140fadc4116bce84d40f43ea3bf345a46cdf85ed1486f5252e79fef |
