GitHub Handle Links - myst-plugins

Automatically converts @username mentions into links to GitHub profiles.

Usage¶

Add to your myst.yml:

project:
  plugins:
    - https://raw.githubusercontent.com/jupyter-book/myst-plugins/main/plugins/github-handle-links/src/index.mjs

Optionally set GITHUB_TOKEN for higher rate limits:

export GITHUB_TOKEN=your_token_here

Example¶

MyST Demo

Thanks to @kirstiejane and @mfisher87 for their work on MyST!
Note that @thisincorrectusername won't resolve and throw a warning (as it should!), and `@usernamesinbackticks` won't be touched.

Thanks to kirstiejane and mfisher87 for their work on MyST! Note that thisincorrectusername won’t resolve and throw a warning (as it should!), and @usernamesinbackticks won’t be touched.

How it works¶

The plugin:

Finds @handle mentions in text
Validates handles via GitHub API
Creates profile links automatically
Skips mentions in code blocks
Filters citation warnings for handled mentions