Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shinosaki/kiji
A simple blogging framework.
https://github.com/shinosaki/kiji
blog bun cloudflare-workers hono
Last synced: 26 days ago
JSON representation
A simple blogging framework.
- Host: GitHub
- URL: https://github.com/shinosaki/kiji
- Owner: shinosaki
- License: mit
- Created: 2023-10-10T01:04:46.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-19T23:05:09.000Z (12 months ago)
- Last Synced: 2024-11-13T16:46:04.622Z (about 2 months ago)
- Topics: blog, bun, cloudflare-workers, hono
- Language: JavaScript
- Homepage: https://blog.shinosaki.com
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kiji
A simple blogging framework.
## Features
- Server-side rendering
- Works on Bun, Cloudflare Workers, etc.
- RSS feed
- Search articles (Full text search is not currently supported)
## Get Started
**Download this repository**
```bash
$ git clone https://github.com/shinosaki/kiji
$ cd ./kiji
```
**Install depends**
```bash
$ npm i
```
**Customize config file**
Config file location is `./config.js`.
- `lang`: Blog's language (Default: `'en'`)
- `onion`: Onion Service's address
If you set onion address, append `Onion-Location` header for response.
- `cache`
- `maxAge`: `Cache-Control` header's `max-age` value (Default: Undefined)
- `menus`: Links for header's menu.
- `links`: Links for side or footer's menu.
- `app`
- `name`: Blog title
- `description`: Blog description
- `copy`: Copyright in footer
- `name`: Copyright name
- `link`: Copyright name's link
**Create new post**
Create new Markdown file to `./asset/posts/` directory.
or Add articles repository as a git submodule.
```bash
$ git submodule add posts.git ./assets/posts
```
**Generate index file**
```bash
$ npm run posts
```
Generated `posts.json` file in `./asstes` directory.
**Start dev server in local**
**Wrangler (Cloudflare Workers)**
```bash
$ npm run dev
```
and Open `http://localhost:8787` in the browser.
**Bun**:
```bash
$ npm run dev:bun
```
and Open `http://localhost:3000` in the browser.
**Deploying**
**Cloudflare Workers**
```bash
$ npm run deploy
```
**Bun**
1. Building standalone binary
```bash
$ npm run build
```
2. Execution binary
```bash
$ npm run production
```
## Author
[Shinosaki](https://shinosaki.com/)
## Dependencies
- hono
- js-yaml
- marked
- zod
- tailwindcss
- wrangler
## License
[MIT](./LICENSE)