blob: 952c1ea847e84632b999edf8f3bc4b58b635b27a (
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
# 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
$ gistatic path/to/git/ -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
```
The requirements are Perl with dependencies:
- [Git::Raw]: Perl bindings to [libgit2];
- [Mustache::Simple]: template library for generating output files;
- [CommonMark][cm-p]: [CommonMark][cm-spec] renderer.
[Git::Raw]: https://metacpan.org/pod/Git::Raw
[libgit2]: https://libgit2.org/
[Mustache::Simple]: https://metacpan.org/pod/Mustache::Simple
[cm-p]: https://metacpan.org/pod/CommonMark
[cm-spec]: https://commonmark.org/
## Documentation
Documentation available via installed manpages, also available online: [`gistatic.1`](gistatic.1.html) and [`gistatic-template.5`](gistatic-template.5.html).
## Contributing
Extra tools used for development are:
- [Perl::Critic] and [B::Lint] for linting;
- [perltidy] for code formatting;
- [ShellCheck] for validating scripts;
- [pandoc] for generating the documentation HTML and website.
[Perl::Critic]: https://metacpan.org/pod/Perl::Critic
[B::Lint]: https://metacpan.org/pod/B::Lint
[perltidy]: https://metacpan.org/pod/perltidy
[ShellCheck]: https://www.shellcheck.net/
[pandoc]: https://pandoc.org/
For running the extra development-only checks, run:
```shell
$ make dev-check
```
and for generating the documentation HTML and website, run:
```shell
$ make public
```
For running the extra development-only checks, run:
```shell
$ make dev-check
```
and for generating the documentation HTML and website, run:
```shell
$ make public
```
Send contributions to the [mailing list] via
[`git send-email`](https://git-send-email.io/).
## Links
- [homepage](https://euandreh.xyz/gistatic/en/)
- [source code](https://git.euandreh.xyz/gistatic/)
- [bug tracking](https://euandreh.xyz/gistatic/TODOs.html)
- [mailing list]
- [CI logs](https://euandreh.xyz/gistatic/ci.html)
- [CHANGELOG](https://euandreh.xyz/gistatic/en/CHANGELOG.html)
[mailing list]: https://lists.sr.ht/~euandreh/public-inbox?search=%5Bgistatic%5D
## License
The code is licensed under
[GNU Affero General Public License v3.0 or later][AGPL-3.0-or-later]
(AGPL-3.0-or-later).
[AGPL-3.0-or-later]: https://git.euandreh.xyz/gistatic/tree/COPYING
|
