Monthly Downloads: 20
Programming language: Haskell
License: MIT License
Tags: CommandLine    
Latest version: v0.20.0
Add another 'CommandLine' Package



Convert Pandoc Markdown-style footnotes into sidenotes

This is a simple Pandoc filter to convert footnotes into a format that can be consumed by Tufte CSS. On the whole, this project weighs in at well under 100 lines of code. Check out [SideNote.hs](src/Text/Pandoc/SideNote.hs) if you're curious how it works.

It's used by calling pandoc --filter pandoc-sidenote. To see it in action, see Tufte Pandoc CSS, a project which uses it. In particular, take a look at the Makefile included in that project.

The core functionality is also exposed as a library, which can be called by Haskell applications such as Hakyll.


pandoc-sidenote is build against a specific version of Pandoc. This table maps pandoc versions to pandoc-sidenote versions:

pandoc pandoc-sidenote
2.9 0.20.0
2.1, 1.19 0.19.0
1.18 0.9.0

If a newer version of pandoc has been released, the Stack build manifest will need to be adjusted for that version, and the project then rebuilt.



pandoc-sidenote is on Hackage and can thus be installed using cabal:

cabal install pandoc-sidenote


If you're on OS X, you can install the pandoc-sidenote binary from my Homebrew tap:

brew install jez/formulae/pandoc-sidenote

From Source

Otherwise, you'll have to install from source. This project is written in Haskell and built using Stack. If you're new to Haskell, now's a perfect time to wet your toes! Go install Stack first, then run these commands:

git clone https://github.com/jez/pandoc-sidenote

cd pandoc-sidenote

# this is going to be reaaally long the first time
stack build

# copy the compiled binary onto your PATH
stack install


MIT License

*Note that all licence references and agreements mentioned in the pandoc-sidenote README section above are relevant to that project's source code only.