summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHimanshu Sardana <himanshusardana2005@gmail.com>2026-03-23 23:38:00 +0000
committerHimanshu Sardana <himanshusardana2005@gmail.com>2026-03-23 23:38:00 +0000
commita5e580cffb8cb037b94f1b4d4c0067e4f66ef5d9 (patch)
treea9e1a0b862a5f493686d10bd30b26aaef9632743 /README.md
parent25787ba6df487f36d0e59de19e4f8ec7c83bd06b (diff)
docs: update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md77
1 files changed, 59 insertions, 18 deletions
diff --git a/README.md b/README.md
index c32cda2..16311df 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,65 @@
-# Kite
+# Kite — Minimal Go Static Site Generator
+
+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
+
-**Kite** is a *blazingly fast* static site generator written in Go. It supports
-multiple themes, boasts near-perfect Lighthouse Scores (99 on Desktop, 94 on
-Mobile)
## Usage
-Place your markdown content in the `content/` directory, the output will be in the `output/` directory
-```txt
-.
-├── content
-│ └── blog
-│ └── test.md
-└── output
- └── blog
- └── test.html
- ```
+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
+```
+
+---
+
+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:
- Run the following command:
- ```bash
- kite
- ```
+* `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.