Lua Filters
A collection of Lua filters for pandoc.
To learn about Lua filters, see the documentation.
Note
This repository does not accept new filter submissions at this time. Please see issue #207 for details.
Collection
A curated list of pandoc Lua filters in separate repositories.
-
abstract-section – allows to write abstracts as a section in the body (instead of having to put it into the metadata).
-
pretty-urls – removes the protocol prefix from link descriptions.
-
section-bibliographies – creates a separate bibliography for each section of a document.
Requirements
Filters are tested against the pandoc version in the latest pandoc/ubuntu Docker image, i.e. usually the latest release. There is no guarantee that filters will work with older versions, but many do.
Some filters depend on external programs, which must be installed separately. Refer to the filters' documentations for detailed requirements.
Installation
All filters can be used without special installation, just by
passing the respective .lua file path to pandoc via
--lua-filter/-L.
User-global installation is possible by placing a filter in within
the filters directory of pandoc's user data directory. This
allows to use the filters just by using the filename, without
having to specify the full file path.
On mac and Linux, the filters can be installed by extracting the archive with
RELEASE_URL=https://github.com/pandoc/lua-filters/releases/latest
curl -LSs $RELEASE_URL/download/lua-filters.tar.gz | \
tar --strip-components=1 --one-top-level=$PANDOC_DIR -zvxf -
where $PANDOC_DIR is a user directory as listed in the output of
pandoc -v.
Contributing
PRs for improvements or bug fixes are welcome. However, we do not accept new filters at this time. However, we do encourage submissions of external repositories to be included as a link in the collection.
Please see CONTRIBUTING.md for information on code contributions.
License
All filters are published under the MIT license by their respective authors. See LICENSE for details.