This is (as yet) a non-official repository for MyST plugins.
Contribute¶
We welcome new plugins! To share your plugin, please fork this repository, add your plugin, update the gallery table below and include an example page to demonstrate its output (note that the toc is in the toc.yml file), then submit a pull request. Edits and improvements to existing plugins are also encouraged.
We distinguish three levels of plugin maturity:
in development: the plugin is still being developed and may have bugs or incomplete features. It may not be fully documented or tested. Use at your own risk.
tested: the plugin has been tested - at least by two developers - and is functional, but may not be fully documented or may have some limitations. Use with caution.
stable: the plugin is stable, well-documented, and has been tested by multiple users. It is ready for production use.
Once a plugin reaches the stable level, we will create a release for it - it then becomes available through an url. All other levels require a download from this git repository.
Creating Releases¶
We use GitHub releases to share plugins in a way that others can reference and use.
Do do so, use the src/release.py script.
It will print a gh command to generate a release for the plugin you specify.
See the docstring of that script for usage information.
Note: Release tags are named after the plugin (e.g., github-issue-table), not semantic versions. Future releases of the same plugin should update the existing release or use dated tags if versioning is needed.
Gallery of plugins¶
| name | functionalities | type | requirements | status | maintainer(s) | Embed link |
|---|---|---|---|---|---|---|
| page-last-updated | A plugin that automatically slots in the latest update date per page | transform | requires to set fetch depth in deploy.yml fetch-depth: 0 | tested | Freek Pols | Link |
| experiment-admonition | A custom admonition with its transform for converting to pdf | directive & transform | requires custom css | stable | Luuk Fröling & Freek Pols | Link |
| intermezzo-admonition | A custom admonition with its transform for converting to pdf | directive & transform | requires custom css | stable | Luuk Fröling & Freek Pols | Link |
| example-admonition | A custom admonition with its transform for converting to pdf | directive & transform | requires custom css | stable | Luuk Fröling & Freek Pols | Link |
| ex-and-sol-pdf | A plugin that converts exercises and solutions to numbered exercises and solutions in both LaTeX and Typst pdf | transform | stable | Luuk Fröling & Freek Pols | Link | |
| updated-date-frontmatter | A plugin which adds the date of the last update to the top of the page | stable | Luuk Fröling & Freek Pols | Link | ||
| iframe | A plugin that replaces iframe elements with a qr code as figure and a caption with the link so that it is accessible in pdf format | transform | in development | Luuk Fröling & Freek Pols | Link | |
| picsum | A plugin that adds a directive to include random images from picsum.photos | directive | stable | Angus Hollands | - | |
| typst-conversion-support | A plugin that converts missing conversions from Latex to Typst | transform | in development | Freek Pols | - | |
| github-issue-table | Renders GitHub issues/PRs as tables from search queries or project URLs. Supports custom columns, multi-column sorting, styled labels, and project fields | directive | GITHUB_TOKEN | in development | choldgraf | - |
| github-issue-link | Automatically decorates GitHub issue/PR links with titles and state badges | transform | GITHUB_TOKEN (optional) | in development | choldgraf | - |
| github-handle-links | Converts @username mentions to GitHub profile links | transform | GITHUB_TOKEN (optional) | in development | choldgraf | - |
| emoji-shortcodes | Converts emoji shortcodes (:smile:) to unicode emojis (😊) at build time | transform | in development | Matt Fisher | - |