MyST GitHub

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

• an {issue-table} directive that renders GitHub issues and PRs as tables
• automatic decoration of GitHub issue links with titles and state badges
• automatic conversion of @username mentions into GitHub profile links

See the documentation for examples and options.

Usage

Add the released bundle to your myst.yml:

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

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

Development

The plugins live in src/ and are bundled into a single dist/index.mjs with esbuild.

bun install
bun run build      # bundle the plugin
bun run test       # build docs, then run the vitest suite
bun run build:docs # build the documentation HTML
bun run docs:live  # live-reload docs server

Export GITHUB_TOKEN before running test or build:docs: the docs build queries the GitHub API, and the tests validate its output. To release, publish a GitHub release with a tag like vX.Y.Z. CI will build the bundle and attach it to the release.

These plugins were originally developed in jupyter-book/myst-plugins.