kita/README.md
2023-10-22 19:11:14 +08:00

50 lines
1.1 KiB
Markdown

# Kita
Kita is a clean, elegant and simple blog theme for Zola.
This theme is based on Hugo theme [hugo-paper](https://github.com/nanxiaobei/hugo-paper) with some features added.
![Screenshot](https://github.com/st1020/kita/blob/main/screenshot.png)
## Features
- Easy to use and modify
- Dark mode
- Social icons
- Taxonomies support
- Table of Content
- Admonition shortcode
- SEO Friendly
- Comments using [Giscus](https://giscus.app/)
- Mathematical notations using [KaTeX](https://katex.org/)
- Diagrams and charts using [Mermaid](https://mermaid.js.org/)
## Installation
The easiest way to install this theme is to clone this repository in the themes directory:
```sh
git clone https://github.com/st1020/kita.git themes/kita
```
Or to use it as a submodule:
```sh
git submodule add https://github.com/st1020/kita.git themes/kita
```
Then set `kita` as your theme in `config.toml`.
```toml
theme = "kita"
```
## Configuration
See the `extra` section in [config.toml](https://github.com/st1020/kita/blob/main/config.toml) as a example.
## License
[MIT License](https://github.com/st1020/kita/blob/main/LICENSE)
Copyright (c) 2013-present, st1020