diff options
| -rw-r--r-- | Makefile | 10 | ||||
| -rw-r--r-- | README.md | 99 |
2 files changed, 64 insertions, 45 deletions
@@ -1,17 +1,15 @@ all: run run: - go run ./cmd + go run . build: - go run ./cmd build + go build . build-release: - echo "Building Kite release" - go build -ldflags="-s -w" -o kite-release ./cmd + go build -ldflags="-s -w" -o kite-release upx --best --lzma kite-release - echo "Successfully built release binary" stat -c %s ./kite-release serve: - go run ./cmd serve + go run . serve @@ -1,66 +1,87 @@ # Kite -Kite is a lightweight (2.7MB) static site generator written in Go. +A fast, minimal static site generator written in Go. Transform Markdown files into beautiful, themed websites with zero dependencies at runtime. -## Features +<p> + <img src="https://img.shields.io/badge/version-1.0.0-blue.svg" alt="Version"> + <img src="https://img.shields.io/badge/Go-1.25+-00ADD8.svg" alt="Go Version"> +</p> -- Markdown to HTML conversion -- Multiple built-in CSS themes -- Simple layout templating -- Fast builds with Go -- Clean output structure +## Installation + +```bash +go install github.com/HimanshuSardana/kite@latest +``` ## Usage -1. Clone the repository +### Initialize a New Blog + ```bash -git clone https://github.com/HimanshuSardana/kite -cd kite +kite init ``` -2. Install dependencies +This interactive command walks you through: +- Blog name and site title +- Author information +- Theme selection +- Creates `content/`, `output/`, `themes/` directories +- Generates config and a sample post + +### Build Your Site + ```bash -go mod tidy +kite build ``` -3. Run the generator +Or specify a theme: + ```bash -make build <theme-name> +kite build gruvbox ``` -(The `themeName` is optional and defaults to `modern-light`) +### Preview Locally -Or use the compiled binary: ```bash -make build-release -./kite-release +kite serve ``` -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> -``` +Visit `http://localhost:8000` to see your site. +## Commands -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. +| Command | Description | +|---------|-------------| +| `kite init` | Initialize a new blog project | +| `kite build` | Build the static site | +| `kite build <theme>` | Build with a specific theme | +| `kite serve` | Start local development server | +| `kite serve --port 8080` | Serve on custom port | +| `kite list-themes` | Show available themes | -Example: -``` -content/test.md → output/test/index.html -``` +## Configuration -## Inbuilt Themes +Edit `config.yaml` to customize your site: + +```yaml +siteTitle: "Your Blog Name" +authorName: "Your Name" +authorRole: "Writer & Developer" +authorBio: "A short bio about yourself" +defaultTheme: "modern-light" +siteUrl: "https://your-domain.com" +``` -Themes are located in the `themes/` directory. +## Themes -Available themes include: +Kite comes with 9 built-in themes: +- modern-light +- modern-dark +- modern-dark-2 +- modern-dark-catppuccin +- everforest +- gruvbox +- rose-pine +- terminal-gruvbox +- tufte -- Modern Light -- Modern Dark -- Gruvbox |