Getting Started

You will need the nix package manager to provide a build environment suitable for running shake. Shakebook has heavy dependencies due to latex, pandoc, and image renderers, so you will want to install cachix and use the cache at Run

cachix use shakebook

to set this up.


First clone the template repository here.

Check that you can drop into a nix shell by running the command


Nix should pull in all the dependencies and set up the build environment for you.

One you’re in the shell, you can just run


and shake will grab all the content in the site/ directory, compile it, and dump it in the public/ directory,


You can use warp, which is provided in the nix-shell, by running

warp -d public

Then navigate to your site at localhost:3000