aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 9cd22bfee7ef46f98ee125ceb43386ffd22e81b423a09cc96c122533c224993a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# Journal

The live Gemini capsule is available at [gemini://nicholasjohnson.ch](gemini://nicholasjohnson.ch).

The live website is available at [https://nicholasjohnson.ch](https://nicholasjohnson.ch).

## Generate Locally

### Required Software

- git
- git annex
- hugo

### Commands

```sh
git clone --recursive https://git.nicholasjohnson.ch/journal && cd journal
git branch --track git-annex origin/git-annex
git annex pull    # this may take some time
git annex unlock  # necessary since Hugo doesn't follow Git Annex's symlinks
hugo -e gemini    # generate capsule in directory "public/capsule"
hugo -e web       # generate website in directory "public/website"
```

## Commit Hugo Pages

To grammar check Hugo pages prior to commit, configure the Git hook. This step is optional.

### Required Software

- language_tool_python

### Commands

```sh
chmod +x hooks/pre-commit
git config --local core.hooksPath hooks
```