gitkyl 0.1.1

Generate static HTML sites from git repositories
Documentation 
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

# Gitkyl

Gitkyl **[GIT-kul]** is a static site generator for git repositories. Pure Rust.

## Install

```bash
cargo install --git https://github.com/lemorage/gitkyl
```

## Use

```bash
gitkyl                                         # current repo → ./dist
gitkyl /path/to/repo                           # specific repo
gitkyl . -o site                               # custom output
gitkyl --name "My Project" --owner "username"  # custom metadata
gitkyl --theme Catppuccin-Mocha                # dark theme
gitkyl --theme base16-ocean.light              # built-in theme
gitkyl --no-open                               # skip auto-open browser
```

### Theme Options

**Included themes:**
- `Catppuccin-Latte` (default) - Modern warm light theme
- `Catppuccin-Mocha` - Modern dark theme
- `InspiredGitHub` - GitHub-style light theme
- `base16-ocean.light`, `base16-ocean.dark` - Cool modern themes
- `Solarized (light)`, `Solarized (dark)` - Eye-strain optimized

**Custom themes:**
```bash
gitkyl --theme path/to/custom.tmTheme   # External .tmTheme file
```

## Output Structure

```
dist/
├── index.html                    # Repository home
├── assets/                       # CSS bundles
├── tree/master/src.html          # Directory listing
├── blob/master/src/main.rs.html  # Code file (highlighted)
├── commits/master/page-1.html    # Commit history (paginated)
└── tags/index.html               # Tag listing
```

## Build

```bash
cargo build --release     # target/release/gitkyl
cargo test                # run all tests
cargo fmt                 # format code
cargo clippy              # lint
```

---

BSD-3-Clause · lemorage