diff options
| author | Himanshu Sardana <himanshusardana2005@gmail.com> | 2026-03-23 23:40:08 +0000 |
|---|---|---|
| committer | Himanshu Sardana <himanshusardana2005@gmail.com> | 2026-03-23 23:40:08 +0000 |
| commit | e22a3138aeca76edfd2bef7bcc6b8fa20469f272 (patch) | |
| tree | 86cc8fe425ef54df4219999d00ebab004970f818 | |
| parent | a5e580cffb8cb037b94f1b4d4c0067e4f66ef5d9 (diff) | |
docs: add config file template
docs: make reamde more minimal
| -rw-r--r-- | README.md | 15 |
1 files changed, 9 insertions, 6 deletions
@@ -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: <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. @@ -47,8 +52,6 @@ Example: content/test.md → output/test/index.html ``` ---- - ## Inbuilt Themes Themes are located in the `themes/` directory. |