pandoc-sidenote: 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 if you're curious how it works.
[Skip to Readme]
Downloads
- pandoc-sidenote-0.23.0.0.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
| Versions [RSS] | 0.19.0.0, 0.20.0.0, 0.22.1.0, 0.22.2.0, 0.22.3.0, 0.23.0.0 |
|---|---|
| Dependencies | base (>=4.7 && <5), mtl, pandoc-sidenote, pandoc-types (>=1.22), text [details] |
| License | MIT |
| Copyright | 2016 Jake Zimmerman |
| Author | Jake Zimmerman |
| Maintainer | zimmerman.jake@gmail.com |
| Category | CommandLine |
| Home page | https://github.com/jez/pandoc-sidenote#readme |
| Bug tracker | https://github.com/jez/pandoc-sidenote/issues |
| Source repo | head: git clone https://github.com/jez/pandoc-sidenote |
| Uploaded | by jez at 2023-05-25T22:29:25Z |
| Distributions | Debian:0.22.1.0, NixOS:0.23.0.0 |
| Reverse Dependencies | 1 direct, 0 indirect [details] |
| Executables | pandoc-sidenote |
| Downloads | 2200 total (31 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2023-05-25 [all 1 reports] |
Readme for pandoc-sidenote-0.23.0.0
[back to package description]pandoc-sidenote
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 and Pandoc Markdown CSS Theme. On the whole, this project weighs in at well under 100 lines of code. Check out 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.
Dependencies
pandoc-sidenote is build against a specific version of Pandoc. This table maps
pandoc versions to pandoc-sidenote versions:
| pandoc | pandoc-sidenote |
|---|---|
| 3.0 | 0.23.0 |
| 2.11 | 0.22.0, 0.22.1, 0.22.2 |
| 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.
Installation
Cabal
pandoc-sidenote is on Hackage and can thus be installed using cabal:
cabal install pandoc-sidenote
Homebrew
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
Notes to myself
Side note: I run this command to generate the zip files attached to releases that are downloaded by the Homebrew formula:
make
It would be nice to get GitHub Actions set up to build and publish releases for each tagged commit automatically.
I run this command to publish packages to Hackage:
# First, edit `package.yaml` to remove `-Werror`, then:
stack upload .
License
