A simple MyST plugin for collecting items, optionally transforming them to add extra metadata, and then displaying them in a variety of structured views.
Out of the box, this plugin supports tables, lists, galleries, summaries, feeds, and sections.
Note
This is an experimental MyST plugin that combines functionality from several other plugins into a single listing directive. It is early-stage and may change. Feedback is welcome.
Reference the released plugin bundle directly from GitHub in your myst.yml.
This pulls the bundle attached to the latest release, so MyST loads it without a build or install step:
project:
plugins:
- https://github.com/myst-contrib/myst-listing/releases/latest/download/plugin.mjsTo pin a specific version, swap latest/download for a tag, e.g. download/v0.1.0.
Alternatively, clone this repository, build the bundle with bun run build (it ends up in dist/plugin.mjs), and reference it from a local path:
project:
plugins:
- path/to/plugin.mjsThen collect a folder of pages and display them.
This shows the pages in posts/ as a table, newest first.
By default a listing shows at most 10 items.
```{listing}
:path: posts/*.md
:columns: title,date
```