Automatically decorates GitHub issue links with titles and state badges.
Usage¶
Add to your myst.yml:
project:
plugins:
- https://raw.githubusercontent.com/jupyter-book/myst-plugins/main/plugins/github-issue-link/src/index.mjsOptionally set GITHUB_TOKEN for higher rate limits:
export GITHUB_TOKEN=your_token_hereExamples¶
Open Issue (🟢)¶
MyST Demo
This open issue https://github.com/jupyter-book/jupyter-book/issues/2481 needs attention.This open issue jupyter
Closed Issue (🟣)¶
MyST Demo
This closed issue https://github.com/jupyter-book/jupyter-book/issues/2050 describes the migration path.This closed issue jupyter
Custom link text¶
You can also use custom link text, and the plugin will add state information:
MyST Demo
For more details, see [this output scroll issue](https://github.com/jupyter-book/jupyter-book/issues/2050) for instructions.For more details, see this output scroll issue for instructions.