From 2bc62aaa80335269871949d4092f0d357904fbb4 Mon Sep 17 00:00:00 2001 From: Himanshu Sardana Date: Mon, 16 Mar 2026 20:56:57 +0000 Subject: docs: add readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..c32cda2 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# Kite + +**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 + ``` + + Run the following command: + ```bash + kite + ``` + -- cgit v1.3.1