https://github.com/jupyter-book/mystmd

Command line tools for working with MyST Markdown.
https://github.com/jupyter-book/mystmd

javascript-parser markdown-it myst myst-markdown myst-parser unifiedjs

Last synced: 11 days ago
JSON representation

Command line tools for working with MyST Markdown.

• Host: GitHub
• URL: https://github.com/jupyter-book/mystmd
• Owner: jupyter-book
• License: mit
• Created: 2020-07-21T22:02:07.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2025-04-09T16:34:13.000Z (15 days ago)
• Last Synced: 2025-04-09T17:39:48.352Z (15 days ago)
• Topics: javascript-parser, markdown-it, myst, myst-markdown, myst-parser, unifiedjs
• Language: TypeScript
• Homepage: https://mystmd.org/guide
• Size: 56.2 MB
• Stars: 334
• Watchers: 9
• Forks: 91
• Open Issues: 469
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-myst - mystmd

README

        
# MyST Markdown Command Line Interface, `mystmd`

[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jupyter-book/mystmd/blob/main/LICENSE)

![CI](https://github.com/jupyter-book/mystmd/workflows/CI/badge.svg)

[![Discord Chat](https://img.shields.io/badge/discord-chat-blue?logo=discord&logoColor=white)](https://discord.mystmd.org)

`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](https://mystmd.org/guide).

## Get Started

Ensure that you have an updated version of Node installed ():

```bash

node -v

>> v20.4.0

```

The MyST Markdown CLI is available through NPM, PyPI and Conda:

```bash

# Using npm, yarn, or pnpm

npm install -g mystmd

# Or using PyPI

pip install mystmd

# Or using Conda / Mamba

conda install mystmd -c conda-forge

```

Usage:

```bash

myst init

myst start

myst build my-doc.md --tex

```

# Development

See [the Contribution Guide](CONTRIBUTING.md) for information on setting up a development environment.

---

As of v1.0.0 this package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c).

---