clerk-utils/custom template

This directory contains a deps-new template that creates a new Clerk project with everything described in the "Custom ClojureScript Builds" section of the clerk-utils documentation notebook already configured.

To use the template, install the deps-new tool:

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

Then create a project using the clerk-utils/custom template:

clojure -Sdeps '{:deps {io.github.mentat-collective/clerk-utils {:git/sha "40e7c7bd358c95d1cc96d76eb6ae5099868e500f"}}}' \
-Tnew create \
:template clerk-utils/custom \
:name myusername/my-notebook-project

See https://github.com/mentat-collective/clerk-utils-custom-template for an example of a fresh project generated from this template, with :name mentat-collective/clerk-utils-custom-template.

Note The :name argument should match the GitHub slug (ie, org_name/project_name) where you expect to host the project. The above command will create a new project in the folder my-notebook-project in the directory where you run the command.

To use a different version of the template, replace the :git/sha above with the sha of version you need from the Clerk-Utils commit history.

The generated project will contains more guides and information in its README.md and in the generated Clerk notebook.

See the Project Template documentation section for more details about this template.

Template Keyword Options

You can customize the clerk-utils/custom template by supplying any of the following key-value pairs to the above command (See template.edn for default values):

:description: This string is inserted at the top of your generated project's README.md.
:clerk-port: the port used by clerk/serve! during interactive development.
:clerk-sha: the hash of the Clerk version you'd like to use in the template. (clerk-utils/custom uses a git dependency for Clerk.)
:shadow-port: the port that shadow-cljs uses to serve compiled JavaScript during interactive development.
:shadow-version: the version of shadow-cljs required by the generated project.
:clj-version: the version of Clojure required by the generated project.
:cljs-version: the version of ClojureScript required by the generated project. (note that this needs to meet or exceed the version declared in the shadow-cljs deps.edn file for the shadow-cljs version you've chosen.)
:http-server-port: The port used by bb serve and bb publish-local to serve the local statically built site.
:cname: If you're serving your GitHub Pages build from a custom URL, pass the value (like "clerk-utils.mentat.org") of the custom site via this argument.

Thanks and Support

To support this work and my other open source projects, consider sponsoring me via my GitHub Sponsors page. Thank you to my current sponsors!

License

Copyright © 2023 Sam Ritchie.

Distributed under the MIT License. See LICENSE.

Uh oh!