Git Product home page Git Product logo

kiji's Introduction

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

$ git clone https://github.com/shinosaki/kiji
$ cd ./kiji

Install depends

$ 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.

$ git submodule add posts.git ./assets/posts

Generate index file

$ npm run posts

Generated posts.json file in ./asstes directory.

Start dev server in local Wrangler (Cloudflare Workers)

$ npm run dev

and Open http://localhost:8787 in the browser.

Bun:

$ npm run dev:bun

and Open http://localhost:3000 in the browser.

Deploying Cloudflare Workers

$ npm run deploy

Bun

  1. Building standalone binary
$ npm run build
  1. Execution binary
$ npm run production

Author

Shinosaki

Dependencies

  • hono
  • js-yaml
  • marked
  • zod
  • tailwindcss
  • wrangler

License

MIT

kiji's People

Contributors

shinosaki avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.