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

66 lines
1.7 KiB
Markdown

# Gokarna
Gokarna is an opinionated theme with a focus on minimalism and simplicity.
Demo: TODO Link
## Features
- Minimalistic & fast
- Customizable header
- Responsive
- Light/Dark theme toggle
- Native fonts
- Syntax highlighting
- Math typesetting
- SEO Ready
- Support for adding custom HTML, which can be used to add snippets or script tags
## 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)
## 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
- Navbar
- Footer
- Inject html (Give example)
- Syntax highlighting (Choose from https://xyproto.github.io/splash/docs/all.html)
- Avatar sizes
- Option to show posts on homepage (Choose one of [popular|recent])
## LICENSE
Apache or MIT ?