808cd0ffb9
* Add gitignore and static icons * Add social icons bar * Add more social icons, fix styling for header * Fix dark theme bug * Remove AWS icon * Add math typesetting to readme features * Templatize social icons * Add documentation and fix menu icon * Add more icons in example site * Fix lang in code blocks * Fix codeblocks lang and use twitch icon * Reduce spacing around and between social icons * Fix icon sizing * Hard code width and height * Fix language in code blocks * Update language * Update Readme * Add screenshot * Update screenshots Co-authored-by: Yash Mehrotra <yashmehrotra95@gmail.com>
87 lines
3.3 KiB
Markdown
87 lines
3.3 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)
|
|
|
|
## Support the developer
|
|
|
|
[](https://www.buymeacoffee.com/avijitgupta)
|
|
|
|
## Features
|
|
|
|
- Minimalistic & fast
|
|
- Customizable header
|
|
- Responsive
|
|
- Available in light and dark themes
|
|
- Native fonts and support for [feather icons](https://feathericons.com/) and [svg icons](http://localhost:1313/posts/theme-documentation-advanced/#icons-on-homepage)
|
|
- Syntax highlighting
|
|
- SEO Ready
|
|
- Option to add custom javascript and css
|
|
- RSS Feed
|
|
- Math typesetting using [Katex](https://gokarna-hugo.netlify.app/posts/theme-documentation-advanced/#katex)
|
|
|
|
## Screenshots
|
|
|
|
### Homepage
|
|
|
|
Light Mode | Dark Mode
|
|
:-------------------------:|:-------------------------:
|
|
 | 
|
|
|
|
### Post page
|
|
|
|
Light Mode | Dark Mode
|
|
:-------------------------:|:-------------------------:
|
|
 | 
|
|
|
|
### List page
|
|
|
|
Light Mode | 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.
|
|
|
|
|
|
|
|
## Performance
|
|
|
|
Google Lighthouse check score: 100%
|
|
|
|
|
|
|
|
## LICENSE
|
|
|
|
This code is licensed under [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.html)
|