-
-
Notifications
You must be signed in to change notification settings - Fork 17
docs: Document Lua filter support for admonitions and document transformation #68
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -59,6 +59,28 @@ You can set keybindings to specific formats in a _keybindings.json_ file. For ex | |
|
|
||
| Setting these skips the format selection prompt and directly exports to the specified format, but you can still use the default render command to choose a format from the list. | ||
|
|
||
| ### Lua Filters | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Citation: Based on PR #60 which adds the |
||
|
|
||
| You can use [Lua filters](https://pandoc.org/lua-filters.html) to transform documents during conversion. Lua filters work with both standard Pandoc and Docker mode. | ||
|
|
||
| - Lua Filters / `pandoc.luaFilters`: List of absolute paths to Lua filter files to pass to Pandoc via `--lua-filter`. | ||
|
|
||
| - Default: `[]` (empty, no filters applied) | ||
|
|
||
| #### Admonition support (Docusaurus-style fenced divs) | ||
|
|
||
| If your Markdown uses [Docusaurus admonitions](https://docusaurus.io/docs/markdown-features/admonitions) (`::: note`, `:::warning`, etc.), you can use a Lua filter to handle them. Community filters like [pandoc-admonition-filter](https://github.com/chdemko/pandoc-admonition-filter) or a custom filter work for this. | ||
|
|
||
| Example `settings.json`: | ||
|
|
||
| ```json | ||
| { | ||
| "pandoc.luaFilters": [ | ||
| "/path/to/admonition-filter.lua" | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| ### Additional Pandoc command line options | ||
|
|
||
| Set additional command line options for each output format. | ||
|
|
@@ -116,6 +138,8 @@ If needed, you can also change the default Pandoc docker image using the `pandoc | |
|
|
||
| ## Releases | ||
|
|
||
| - March 2026 | ||
| - Add Lua filter support (`pandoc.luaFilters`) for document transformation, including Docusaurus-style admonition rendering | ||
|
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Citation: Release note entry for the Lua filter feature from PR #60. The PR description explains this addresses Docusaurus admonition support (fixes #36). |
||
| - March 12th, 2026 | ||
| - Dependency updates | ||
| - Export options sorted by usage by default with a setting to override | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Line 213)
Citation: Release notes entry based on PR #60 which adds Lua filter support via
pandoc.luaFiltersand built-in admonition rendering viapandoc.enableAdmonitions.View source