summaryrefslogtreecommitdiff
path: root/README.md
blob: 595713c7f81c31269dc4dc3271370cb776f4e74d (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
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
# Kite

Kite is a lightweight (2.8MB) static site generator written in Go. 

## Features

- Markdown to HTML conversion
- Multiple built-in CSS themes
- Simple layout templating
- Fast builds with Go
- Clean output structure

## Usage

1. Clone the repository
```bash
git clone https://github.com/HimanshuSardana/kite
cd kite
```

2. Install dependencies
```bash
go mod tidy
```

3. Run the generator
```bash
go run main.go
```

Or use the compiled binary:
```bash
./kite-release
```

Modify the `config.yaml` file with your info, it'll be used to generate the home page
```yaml
siteTitle: <enter your site's title>
authorName: <enter your name>
authorRole: <enter your role>
authorBio: <enter your bio>
```


To write new posts
- Add Markdown files inside the `content/` directory.
- Each file will be converted into its own page.
- Folder structure is preserved in output.

Example:
```
content/test.md → output/test/index.html
```

## Inbuilt Themes

Themes are located in the `themes/` directory.

Available themes include:

* `modern-light.css`
* `modern-dark.css`
* `everforest.css`
* `rose-pine.css`
* `terminal-gruvbox.css`
* `tufte.css`

To change a theme, update your layout or configuration to reference the desired CSS file.