# myst-frontmatter

> Frontmatter types and validation for the mystmd ecosystem

Latest version **1.10.2** (published 2026-10-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install myst-frontmatter
pnpm add myst-frontmatter
yarn add myst-frontmatter
bun add myst-frontmatter
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.10.2 |
| Published | 2026-10-26 |
| First published | 2022-09-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 6 |
| Unpacked size | 255.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 533 |
| Author | Franklin Koch |
| Maintainers | rowanc1, stevejpurves, ebp-bot |

## Links

- npm: https://www.npmjs.com/package/myst-frontmatter
- Repository: https://github.com/jupyter-book/mystmd
- Homepage: https://github.com/jupyter-book/mystmd/tree/main/packages/myst-frontmatter
- Issues: https://github.com/jupyter-book/mystmd/issues
- npm.io page: https://npm.io/package/myst-frontmatter

## Dependencies (6)

- [orcid](https://npm.io/package/orcid.md) ^1.0.0
- [myst-toc](https://npm.io/package/myst-toc.md) ^0.1.5
- [doi-utils](https://npm.io/package/doi-utils.md) ^2.0.5
- [credit-roles](https://npm.io/package/credit-roles.md) ^2.1.0
- [spdx-correct](https://npm.io/package/spdx-correct.md) ^3.2.0
- [simple-validators](https://npm.io/package/simple-validators.md) ^1.2.1

## Recent versions

- 1.10.2 (latest) — 2026-10-26
- 1.10.1 — 2026-09-21
- 1.10.0 — 2026-06-04
- 1.9.5 — 2026-03-03
- 1.9.4 — 2026-01-21
- 1.9.3 — 2025-12-10
- 1.9.2 — 2025-12-04
- 1.9.1 — 2025-12-01
- 1.9.0 — 2025-11-18
- 1.8.4 — 2025-11-03
- 1.8.3 — 2025-10-10
- 1.8.2 — 2025-09-08
- 1.8.1 — 2025-07-05
- 1.8.0 — 2025-06-24
- 1.7.13 — 2025-06-16
- … 85 more at https://npm.io/package/myst-frontmatter/versions

## 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.

## 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 (<https://nodejs.org/>):

```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).

---

---
_Source: https://npm.io/package/myst-frontmatter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._