Repository files navigation

A collection of Lua filters for pandoc.

To learn about Lua filters, see thedocumentation.

Warning

This repository is in the process ofbeing retired. Pleasesee the next section for details.

We no longer accept new filter submissions and will only applysmall patches to the existing filters.

The most popular filters have been or will be transferred to the[pandoc-ext] organization. Please raise an issue in theinfo repository if your favorite filter has notbeen re-published yet.

A list of extensions is available in thepandoc-ext/inforepository. See also thepandoc andpandoc-filter GitHub topics.

We want the ecosystem to be distributed, but also try to make iteasy to discover new software. That's why we ask filter authors toadd thepandoc andpandoc-filter to the GitHub repositories,as enables others to explore filters through GitHub's interface.

Additionally, please add a link to your filter to thepandoc-ext/info repository.

There are multiple reasons why this repository is discontinued:

• Maintenance – supporting all filters in this repository becameunsustainable. As put by John MacFarlane inissue #207:

  One drawback of the current structure is that people submitcode here but then don't monitor the repository, and issuesare neglected.

  This put a lot of work on not enough shoulders, with the resultthat code wasn't properly maintained.

• Credit and ownership – authors should get proper credit fortheir work, but putting all filters in one repository makestheir contributions less visible. Repositories owned by theoriginal authors makes it obvious who put in all the work andwho is responsible.

• Interoperability – many filters are useful forQuarto users;having one repository per filter makes it possible to supportQuarto's extension mechanism, enabling users to install thefilters with thequarto install extension command.

Filters are tested against the pandoc version in the latestpandoc/ubuntu Docker image, i.e. usually the latest release. Thereis no guarantee that filters will work with older versions, butmany do.

Some filters depend on external programs, which must be installedseparately. Refer to the filters' documentations for detailedrequirements.

All filters can be used without special installation, just bypassing the respective.lua file path to pandoc via--lua-filter/-L.

User-global installation is possible by placing a filter in withinthefilters directory of pandoc's user data directory. Thisallows to use the filters just by using the filename, withouthaving to specify the full file path.

On mac and Linux, the filters can be installed by extracting thearchive with

RELEASE_URL=https://github.com/pandoc/lua-filters/releases/latestcurl -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 ofpandoc -v.

PRs for improvements or bug fixes are welcome. However, we do notaccept new filters at this time. However, wedo encouragesubmissions of external repositories to be included as a link inthe collection.

Please see CONTRIBUTING.md for information on code contributions.

All filters are published under the MIT license by theirrespective authors. See LICENSE for details.