aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 9238a7ef94352a347e273902d7f6bfeb968388d5 (plain) (blame)
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
# gistatic

Static Git repository generator

Generate HTML pages for a Git repository.  The generated pages are
static and offline-first, and can be made available online as static
assets.

## Usage

Generate static HTML website for Git repository:

```shell
$ cd path/to/git/repo/
$ gistatic -o public/
```

## Installation

Get the latest tarball and install it:

```
wget https://euandreh.xyz/gistatic/tarballs/gistatic-main.tar.gz
tar xvf gistatic-main.tar.gz
cd gistatic-main/
make
[sudo] make install
```

## Documentation

Documentation available via installed manpages, also available online: [`gistatic.1`](gistatic.1.html).