Generated with Clerk

Clerk Garden

A simple publishing space for Clerk notebooks.

Enter a GitHub repo to build and publish.

or click here to try an example: nextjournal/clerk-demo

How does it work?

1. Add a :nextjournal.clerk to :aliases in your deps.edn file:

{:deps ...
 :aliases
 {:nextjournal/clerk
  {:exec-fn nextjournal.clerk/build!
   :exec-args {:paths ["notebooks/hello_garden.clj"]}
   ;; TODO: add all notebooks you want to have built ☝️
   ;; if you just want to build one notebook, set `:index`

   ;; optional list of aliases to include in the build
   :nextjournal.clerk/aliases [:dev]}}}

2. Try it out locally to make sure it works

Entering the following command into your terminal should build your notebooks and open an index page in your browser.

clj -X:nextjournal/clerk :browse true

Prepend any extra aliases: clj -X:dev:nextjournal/clerk

3. Push it to GitHub and done!

Clerk Garden mirrors your GitHub URLs, so: