MyST GitHub

MyST plugins for working with GitHub content in your documents, bundled as a single plugin:

• Issue tables: render GitHub issues and PRs as tables from search queries or project URLs.

• Issue links: decorate GitHub issue links with titles and state badges.

• Handle links: convert @username mentions into links to GitHub profiles.

Usage¶

Reference the released plugin bundle in your myst.yml:

project:
  plugins:
    - https://github.com/myst-contrib/myst-github/releases/latest/download/index.mjs

To pin a specific version, swap latest/download for a tag, e.g. download/v0.1.0.

Tokens and caching¶

The plugins use the GitHub API, so set a GITHUB_TOKEN environment variable to avoid rate limits:

export GITHUB_TOKEN=ghp_...

API responses are cached in _build/cache/ for 24 hours, so repeated builds don’t re-fetch the same data.