uprootiny/hortus

Clerk Templates

A collection of deps-new templates that make it easy to get started with Clerk.

Templates

This project defines the following templates:

• clerk/notebook: Basic template for writing notebooks with Clerk
• clerk/custom: Template for a Clerk project that includes custom ClojureScript or uses external plugins

First, install deps-new:

clojure -Ttools install io.github.seancorfield/deps-new '{:git/tag "v0.4.13"}' :as new

Note If you don't have clojure installed, follow the instructions at clojure.org.

To create a new notebook project based on clerk/notebook, run the following command:

clojure -Sdeps '{:deps {io.github.nextjournal/clerk-cljs-demo {:git/sha "b805370715fdcaf34f6a9d6cb2efc2b12153c90c"}}}' \
  -Tnew create \
    :template clerk/custom \
    :name myusername/notebooks

This will generate a project in the directory notebooks, with myusername as the top-level namespace and notebooks as main namespace.

Customizing Templates

Each template takes a number of options for customization! See each template's directory (hyperlinked above) for a description of the customization options the template accepts.

License

Copyright © 2023 Nextjournal.

Distributed under the MIT License. See LICENSE.