Files
gokarna/README.md
Avijit Gupta b9d6210fdb Minor fixes (#52)
* Add beach image jpg and webp

* Fix images and avatar css

* Increase border width, add links to feather icons in basic doc

* Add robots txt file

* Remove paginate

* Update documentation
2021-08-14 01:15:50 +05:30

76 lines
2.4 KiB
Markdown

# Gokarna
Gokarna is an opinionated theme with a focus on minimalism and simplicity.
### Authors:
1. [Yash Mehrotra](https://yashmehrotra.com)
2. [Avijit Gupta](https://twitter.com/526avijit)
### Demo: [https://gokarna-hugo.netlify.app](https://gokarna-hugo.netlify.app)
## Features
- Minimalistic & fast
- Customizable header
- Responsive
- Available in light and dark themes
- Native fonts and support for [feather icons](https://feathericons.com/)
- Syntax highlighting
- SEO Ready
- Option to add custom javascript and css
- RSS Feed
## Screenshots
### Homepage
Light Mode | Dark Mode
:-------------------------:|:-------------------------:
![Light mode](/images/screenshot-light-home.png "Light mode") | ![Dark mode](/images/screenshot-dark-home.png "Dark mode")
### Post page
Light Mode | Dark Mode
:-------------------------:|:-------------------------:
![Light mode](/images/screenshot-light-post.png "Light mode") | ![Dark mode](/images/screenshot-dark-post.png "Dark mode")
### List page
Light Mode | Dark Mode
:-------------------------:|:-------------------------:
![Light mode](/images/screenshot-light-list.png "Light mode") | ![Dark mode](/images/screenshot-dark-list.png "Dark mode")
## Installation
Follow details installation steps in the [documentation here](https://gokarna-hugo.netlify.app/posts/theme-documentation-basics/#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](https://gokarna-hugo.netlify.app/posts/theme-documentation-basics/) and [advanced](https://gokarna-hugo.netlify.app/posts/theme-documentation-advanced/) theme documentation. A gist of things you can customize:
- Navigation menu
- 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](/images/gokarna.jpg)
## LICENSE
This code is licensed under [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.html)