Skip to content

d-zero-dev/kamado

Repository files navigation

Kamado

kamado

Kamado is a distinctively simple static site generator. No hydration, no client-side runtime, no magic. Just your filesystem and raw HTML, baked on demand.

English Documentation | 日本語ドキュメント


About Kamado

Kamado is a static site build tool that aims for a simpler design, similar to 11ty but with a focus on "No Runtime". It generates pure static HTML, ensuring robustness and longevity.

For detailed usage and configuration, please refer to the documentation below:

Monorepo Structure

This repository is a monorepo managed by Lerna.

Package Description Version
kamado Core static site generator engine npm version
@kamado-io/page-compiler Page/HTML compiler with transform pipeline npm version
@kamado-io/pug-compiler Pug template compiler npm version
@kamado-io/script-compiler JavaScript/TypeScript bundler (esbuild) npm version
@kamado-io/style-compiler CSS/SCSS processor (PostCSS) npm version

Development

Prerequisites

  • Node.js
  • Yarn

Commands

Run these commands from the root directory:

  • yarn build: Build all packages.
  • yarn dev: Run development scripts.
  • yarn test: Run tests using Vitest.
  • yarn lint: Run linters (ESLint, Prettier, textlint, cspell).

Contributing

Please read the documentation in packages/kamado for details on how Kamado works.

License

MIT

About

Bake your HTML hard. The on-demand static site generator.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors