Plugins for JB2
Test procedure¶
Include the plugin in this MysT book
Make use of the plugin (e.g. call the admonition)
Local test build book (myst start)
Local test build pdf (myst build --pdf)
plugins available¶
| plugin | description | release link |
|---|---|---|
| example | adds example support to PDF conversion | https:// |
| experiment | adds experiment support to PDF conversion | https:// |
| iframe | Turns iframes into QR codes during PDF conversion | https:// |
| intermezzo | adds intermezzo support to PDF conversion | https:// |
| exercise | adds exercise support to PDF conversion | https:// |
| read-csv | example package, showcasing how to load information from CSV file in a plugin | example only |
| Gallery-generator | creates a gallery using information provided in .yml file | example only |
| CSS | description | release link |
|---|---|---|
| plugin css | main css file used by all plugins described above | https:// |
| TUD style | provides TUD style | https:// |
adding plugins to project¶
Add following to myst.yml file:
myst.yml
project:
plugins:
- https://github.com/TUD-JB-Templates/JB2_plugins/releases/download/example/example.mjsCSS file needed for rendering the plugin admonitons. The CSS file can be included as
myst.yml
site:
template: book-theme
options:
style: https://github.com/TUD-JB-Templates/JB2_plugins/releases/download/CSS/custom.css