2021-11-11 16:10:57 +01:00
# Zola theme built with tailwindcss
zola-tailwind is a [Zola ](https://www.getzola.org/ ) theme built with tailwindcss
2021-11-23 22:03:35 +01:00
(WIP) Example : [Here ](https://tchartron.com )
2021-11-11 16:10:57 +01:00
## Features
2021-11-11 16:14:35 +01:00
- [X] Dark mode
2021-11-11 16:10:57 +01:00
- [X] Customizable navbar links
- [X] Tags and Categories taxonomies
2021-11-30 20:44:08 +01:00
- [X] Search functionality supporting Command + K shortcut
2021-11-11 16:14:35 +01:00
- [X] Social links (github, gitlab, twitter, linkedin, email)
2021-11-30 20:44:08 +01:00
- [X] Postcss build process with cssnano (and tailwindcss tree shaking to reduce final bundle size)
2021-11-11 16:10:57 +01:00
- [X] Uglifyjs build process with minification
- [X] Example script to deploy to Github Pages
2021-11-11 23:55:47 +01:00
- [X] Pagination
2021-11-30 20:44:08 +01:00
- [X] Sidemenu menu with sections links
2021-11-13 19:02:57 +01:00
- [X] Table of content (2 levels and currently viewed part highlighted)
2021-11-30 20:44:08 +01:00
- [X] Multilingue
2021-11-14 14:42:41 +01:00
- [X] 404
2021-11-17 22:43:51 +01:00
- [X] Mobile responsive
2021-11-21 23:23:03 +01:00
- [X] Favicon
2021-11-23 22:03:35 +01:00
- [ ] Adsense
2021-11-30 20:44:08 +01:00
## Usage
You should follow the [official documentation ](https://www.getzola.org/documentation/themes/installing-and-using-themes/ ) about installing a Zola theme.
I recommend adding the theme as a git submodule :
```bash
cd my-zola-website
git submodule add -b main git@github .com:tchartron/zola-tailwind.git zola-tailwind
```