https://github.com/zachcp/ghclerk

template for working with clerk
https://github.com/zachcp/ghclerk

Last synced: about 1 month ago
JSON representation

template for working with clerk

• Host: GitHub
• URL: https://github.com/zachcp/ghclerk
• Owner: zachcp
• License: epl-1.0
• Created: 2022-10-02T01:42:48.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-02T13:19:26.000Z (over 2 years ago)
• Last Synced: 2025-04-26T04:55:58.388Z (about 2 months ago)
• Language: Clojure
• Size: 2.89 MB
• Stars: 4
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# zachcp/ghclerk

A template to get started with clojure. Features building with `clerk` and deploying of static sites with `GitHub`.

## Usage

The easiest way to use this template is if you have clojure and neil installed.

```sh

# install system dependencies and optional editor

brew install clojure neil

brew install --cask visual-studio-code

# create a new repo. try: `neil new help`

# for a new repo called `ghclerktest`

neil new  zachcp/ghclerk ghclerktest \

    --url https://github.com/zachcp/ghclerk \

    --latest-sha

# open editor in your new templated repo

cd ghclerktest && code .

# follow the suggestions above/below to:

#  1. install VScode/Calva 

#  2. start and "jack-in" to a Clojure REPL

#  3. send code to the REPL and watch in evaluate

```

### VSCode + Calva

![](images/getstarted/getstarted.001.jpeg)

### Starting the REPL

![](images/getstarted/getstarted.002.jpeg)

### Geting Started

![](images/getstarted/getstarted.003.jpeg)

## Deploying

If you push your new repository to Github the Github Actions system will be configured to build and push any `clj` namespaces as a clerk notebook. However, you do need to give the Github Actions system authorization to use Github Pages.

![](images/ghactions.png)