Files
gokarna/README.md
2021-08-05 21:06:18 +05:30

68 lines
1.9 KiB
Markdown

# Gokarna
Gokarna is an opinionated theme with a focus on minimalism and simplicity.
Demo: TODO Link
## Features
- Minimalistic & fast
- Customizable header
- Responsive
- Support for light and dark themes
- Native fonts
- Syntax highlighting
- SEO Ready
- Option to add custom javascript and css
## Screenshots
### Homepage
Light Mode | Dark Mode
:-------------------------:|:-------------------------:
![Light mode](/.project/screenshot-light-home.png "Light mode") | ![Dark mode](/.project/screenshot-dark-home.png "Dark mode")
### Post page
Light Mode | Dark Mode
:-------------------------:|:-------------------------:
![Light mode](/.project/screenshot-light-post.png "Light mode") | ![Dark mode](/.project/screenshot-dark-post.png "Dark mode")
### List page
Light Mode | Dark Mode
:-------------------------:|:-------------------------:
![Light mode](/.project/screenshot-light-list.png "Light mode") | ![Dark mode](/.project/screenshot-dark-list.png "Dark mode")
## Installation
```sh
git submodule add https://github.com/526avijitgupta/gokarna.git themes/gokarna
```
## Customization
For a complete guide on customization, please go through our [basic](TODO: Link) and [advanced](TODO: Link) theme documentation. A gist of things you can customize:
- Navbar
- Avatar image and size
- Accent color
- Theme mode (Auto, Light & Dark)
- Custom HTML in head section for loading any scripts
- Syntax highlighting
- Option to show posts recent or popular homepage.
- Footer
## Inspiration
The theme is inspired by and accordingly named after [Gokarna](https://en.wikipedia.org/wiki/Gokarna,_Karnataka), a small and peaceful beach town on the west coast on India.
![Gokarna](/.project/gokarna.jpg)
## LICENSE
This code is licensed under [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.html)