Skip to content

docs: Document Lua filter support for admonitions and document transformation#68

Open
promptless[bot] wants to merge 2 commits into
mainfrom
promptless/lua-filters-docs-improvements
Open

docs: Document Lua filter support for admonitions and document transformation#68
promptless[bot] wants to merge 2 commits into
mainfrom
promptless/lua-filters-docs-improvements

Conversation

@promptless

@promptless promptless Bot commented Mar 26, 2026

Copy link
Copy Markdown

Open this suggestion in Promptless to view citations and reasoning process

Adds documentation for the new pandoc.luaFilters setting that enables Lua filter support, including a note about Docker compatibility and a practical example for Docusaurus-style admonitions. Also adds a release notes entry.

Trigger Events

ChrisChinchilla/vscode-pandoc PR #60: Add Lua filter support (pandoc.luaFilters) for admonition rendering

Promptless Research (4 files, 1 GitHub PR)

  • Reviewed ChrisChinchilla/vscode-pandoc#60
  • Viewed .long_term_context/product_knowledge/product_overview.md
  • Viewed .long_term_context/doc_workflow/client_instructions.md
  • Viewed .long_term_context/style/client_style_guide.md
  • Viewed README.md

Agent Response

I've reviewed PR #60 which adds Lua filter support to vscode-pandoc and created a documentation suggestion.

Summary

PR #60 adds a new pandoc.luaFilters setting that lets users specify Lua filter files for document transformation during Pandoc conversion. The primary use case is supporting Docusaurus-style admonitions (::: note, :::warning, etc.).

Documentation Created

I've created a suggestion that documents this feature with the following improvements over the PR's included documentation:

  1. Docker compatibility note - Explicitly mentions that Lua filters work with both standard Pandoc and Docker mode (the PR's docs didn't highlight this, but the code supports it)

  2. Streamlined prose - Made the descriptions more concise while preserving all technical details

  3. Release notes entry - Added an entry to the Releases section documenting this new feature

Suggestion URL: https://app.gopromptless.ai/suggestions/83c7435d-d79b-411e-8d55-f9239e17e25d

The documentation follows the existing README structure, using the same settings format (e.g., - Setting Name / \pandoc.settingName`) and includes a practical settings.json` example for admonition filter configuration.


Tip: Add or adjust Promptless's style guide in Agent Knowledge Base ✍️

Comment thread README.md

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

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Citation: Based on PR #60 which adds the pandoc.luaFilters setting. The PR's README changes (README.md diff) documented the feature, and I added an explicit note about Docker mode compatibility based on changes in src/extension.ts showing Lua filters are appended to both standard and Docker commands.
View source

Comment thread README.md Outdated
## Releases

- March 2026
- Add Lua filter support (`pandoc.luaFilters`) for document transformation, including Docusaurus-style admonition rendering

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The 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).
View source

@promptless

promptless Bot commented Mar 29, 2026

Copy link
Copy Markdown
Author

I've added new changes to address this GitHub PR in commit 049b0fa

Comment thread README.md

Copy link
Copy Markdown
Author

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.luaFilters and built-in admonition rendering via pandoc.enableAdmonitions.
View source

@promptless
promptless Bot marked this pull request as ready for review March 29, 2026 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants