GitHub Handle Links - MyST GitHub

Automatically converts @username mentions into links to GitHub profiles. See the index page for installation and tokens.

Example¶

Where handles will be added:

- Thanks to @kirstiejane and @mfisher87 for their work on MyST!
- Mentions in parentheses (@mfisher87) or quotes "@kirstiejane" work too.
- Already-linked handles get an avatar and styling: [@kirstiejane](https://github.com/kirstiejane)

Where they won't:

- Incorrect usernames: @thisuserwontbelinked
- Literal spans: `@usernamesinbackticks`
- Linked handles to non-github urls: [@kirstiejane](https://mystmd.org).
- File paths such as node_modules/@remix-run aren't linked.

Where handles will be added:

Thanks to @kirstiejane and @mfisher87 for their work on MyST!
Mentions in parentheses (@mfisher87) or quotes “@kirstiejane” work too.
Already-linked handles get an avatar and styling: @kirstiejane

Where they won’t:

Incorrect usernames: thisuserwontbelinked
Literal spans: @usernamesinbackticks
Linked handles to non-github urls: @kirstiejane.
File paths such as node_modules/remix-run aren’t linked.