From e22a3138aeca76edfd2bef7bcc6b8fa20469f272 Mon Sep 17 00:00:00 2001 From: Himanshu Sardana Date: Mon, 23 Mar 2026 23:40:08 +0000 Subject: docs: add config file template docs: make reamde more minimal --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 16311df..595713c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Kite — Minimal Go Static Site Generator +# Kite Kite is a lightweight (2.8MB) static site generator written in Go. @@ -10,8 +10,6 @@ Kite is a lightweight (2.8MB) static site generator written in Go. - Fast builds with Go - Clean output structure - - ## Usage 1. Clone the repository @@ -35,7 +33,14 @@ Or use the compiled binary: ./kite-release ``` ---- +Modify the `config.yaml` file with your info, it'll be used to generate the home page +```yaml +siteTitle: +authorName: +authorRole: +authorBio: +``` + To write new posts - Add Markdown files inside the `content/` directory. @@ -47,8 +52,6 @@ Example: content/test.md → output/test/index.html ``` ---- - ## Inbuilt Themes Themes are located in the `themes/` directory. -- cgit v1.3.1