# Kilim

> Documentation for Kilim, the static site generator with zero JavaScript by default and SEO checks at build time.

## Docs

- [Introduction](https://docs.kilim.dev/): Kilim is a static site generator for developers, with zero JavaScript by default and SEO checks at build time.
- [Getting started](https://docs.kilim.dev/getting-started/): Create a Kilim site, learn its files and the commands you run while working on it.
- [Installation](https://docs.kilim.dev/getting-started/installation/): Create a Kilim site with npm create kilim from the blog, landing or docs template.
- [Project structure](https://docs.kilim.dev/getting-started/project-structure/): The files and folders of a Kilim site and what each one is for.
- [Commands](https://docs.kilim.dev/getting-started/commands/): Every kilim command, what it does and the options it takes.
- [Content](https://docs.kilim.dev/content/): How Markdown files become pages, how collections group them and how schemas check their frontmatter.
- [Collections and schemas](https://docs.kilim.dev/content/collections/): Group content files into collections, check their frontmatter with a schema and list them.
- [URLs and redirects](https://docs.kilim.dev/content/urls/): How Kilim turns file paths into URLs, permalink patterns, trailing slashes and redirects from old URLs.
- [Markdown](https://docs.kilim.dev/content/markdown/): GitHub Flavored Markdown, code highlighting, heading links, components and pages made of blocks.
- [Multiple languages](https://docs.kilim.dev/content/i18n/): Translate pages with locale suffixes, pair them with translationKey, and give each language its own settings and text.
- [Dev server and admin](https://docs.kilim.dev/dev/): kilim dev rebuilds the site as you save, shows drafts and build errors, and serves a local admin.
- [Admin](https://docs.kilim.dev/dev/admin/): The local admin of kilim dev at /admin/, for content, block pages, media, theme settings and the trash.
- [Themes](https://docs.kilim.dev/themes/): Use the default theme, change its settings and override its parts, or build a theme of your own.
- [Using a theme](https://docs.kilim.dev/themes/using-a-theme/): Pick a theme by name, switch it in one line, change its settings and override its parts without forking it.
- [Writing a theme](https://docs.kilim.dev/themes/writing-a-theme/): Create a local theme, extend another theme, style it and share it on GitHub or npm.
- [Components and blocks](https://docs.kilim.dev/themes/components-and-blocks/): Write Markdown components with defineComponent and page sections with defineBlock, with typed props and examples.
- [Plugins](https://docs.kilim.dev/plugins/): Add plugins to a Kilim site, configure the built-in ones and turn on search and llms.txt.
- [Writing plugins](https://docs.kilim.dev/plugins/writing-plugins/): Define a Kilim plugin with build hooks, frontmatter fields, audit rules and client scripts.
- [Deploy](https://docs.kilim.dev/deploy/): Publish a Kilim site by uploading dist/ yourself or with kilim deploy and an adapter.
- [GitHub Pages](https://docs.kilim.dev/deploy/github-pages/): Publish a Kilim site to GitHub Pages with the Pages artifact or the stable git adapter.
- [Cloudflare Pages](https://docs.kilim.dev/deploy/cloudflare-pages/): Publish a Kilim site to Cloudflare Pages with the experimental cloudflarePages adapter.
- [S3, R2 and MinIO](https://docs.kilim.dev/deploy/s3/): Upload a Kilim site to Amazon S3, Cloudflare R2 or MinIO with the experimental s3 adapter.
- [SFTP and FTP](https://docs.kilim.dev/deploy/sftp-and-ftp/): Upload a Kilim site to a server over SFTP or FTPS with the experimental sftp and ftp adapters.
- [Reference](https://docs.kilim.dev/reference/): Every config option, every kilim check rule and the generated collection types.
- [Config options](https://docs.kilim.dev/reference/config/): Every option of kilim.config.ts, what it does and its default value.
- [Audit rules](https://docs.kilim.dev/reference/audit-rules/): The rules kilim check runs over a build, their severities and options, and its output formats.
- [Collection types](https://docs.kilim.dev/reference/types/): Generate TypeScript types from the collection schemas with kilim types and use typed frontmatter in layouts.