Binder

Binder is a tool that compiles notes into a single file.

Setup

Using Stack

The easiest way to setup Binder is using stack. Stack has sane defaults for sandboxing haskell projects. It also automatically downloads a compatible version of GHC for the project.

cd path/to/store/repository
git clone https://github.com/jhstanton/Binder.git
cd Binder
stack install

You may want to add the folder that stack copies binaries to to your PATH for convenience. For example, the path on my machine is /home/my-user/.local/bin. You can add it to your PATH with

export PATH=$PATH:/your/stack/path

in your ~/.bashrc or ~/.zshrc

Using Cabal

Alternatively, you can use cabal to build the binary. The process is similar, but does require an additional sandboxing step to not mess up global packages. Cabal also requires that GHC is installed.

cd path/to/store/repository
git clone https://github.com/jhstanton/Binder.git
cd Binder
cabal update
cabal sandbox init
cabal install

Current State

Binder currently compiles all markdown files with extension .note from the current directory and all subdirectories into a single HTML file. In commit 8de0fb253e567ce5bac0ad8d208f69ffd976b1c7 the library switched from the markdown package to pandoc to better support tables and math.

The HTML output is sorted by directories and last modified date (directories are sorted by last modified date as well).

Next Steps

Since pandoc is now used, the meta data in pandocs should be leveraged to update sorting (for example, by creation date rather than last modification date).

Support for diagrams, ala diagrams, is desirable, possibly using diagrams-pandoc.