fosscat-site/themes/gokarna/README.md

# Gokarna

Gokarna is an opinionated theme with a focus on minimalism and simplicity.

### Authors:

- [Yash Mehrotra](https://yashmehrotra.com)
- [Avijit Gupta](https://twitter.com/526avijit)

#### Major Contributors
- [James Davidson](https://jamesdavidson.xyz)
- [David Kröll](https://davidkroell.com)
- [Mansoor Barri](https://mansoorbarri.com)

### Demo: [https://gokarna-hugo.netlify.app](https://gokarna-hugo.netlify.app)

## Support the developer

<a href="https://github.com/sponsors/gokarna-theme">
  <img src="https://img.shields.io/badge/Sponsor-❤-red?style=for-the-badge" width="170" height="37" alt="Sponsor us">
</a>

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/avijitgupta)

## Features

Gokarna is fast, responsive, and [SEO-friendly](#performance).

- Light and dark modes
- [Feather](https://feathericons.com/) and [Simple](https://gokarna-hugo.netlify.app/posts/theme-documentation-advanced/#icons-on-homepage) icons
- [KaTeX](https://gokarna-hugo.netlify.app/posts/theme-documentation-advanced/#katex) math typesetting 
- [Syntax highlighting](https://gokarna-hugo.netlify.app/posts/theme-documentation-advanced/#syntax-highlighting)
- [Custom HTML, JavaScript, and CSS](https://gokarna-hugo.netlify.app/posts/theme-documentation-advanced/#custom-head-and-footer-html)
- [Configurable Table of Contents](https://gokarna-hugo.netlify.app/posts/theme-documentation-advanced/#table-of-contents)
- Español (Spanish/Catalan), Deutsch (German), Français (French), Polski (Polish), Português Brasileiro (Brazilian Portuguese), Русский (Russian), and 正體字 (Traditional Chinese) [translations](https://github.com/gokarna-theme/gokarna-hugo/tree/main/i18n)
- Google Lato fonts
- Auto-generated RSS feed

And more...

## Screenshots

### Homepage

Light Mode                                                      | Dark Mode
:-------------------------:|:-------------------------:
![Light mode](https://raw.githubusercontent.com/526avijitgupta/gokarna/main/images/screenshot-light-home.png "Light mode") | ![Dark mode](https://raw.githubusercontent.com/526avijitgupta/gokarna/main/images/screenshot-dark-home.png "Dark mode")

### Post page

Light Mode                                                      | Dark Mode
:-------------------------:|:-------------------------:
![Light mode](https://raw.githubusercontent.com/526avijitgupta/gokarna/main/images/screenshot-light-post.png "Light mode") | ![Dark mode](https://raw.githubusercontent.com/526avijitgupta/gokarna/main/images/screenshot-dark-post.png "Dark mode")

### List page

Light Mode                                                      | Dark Mode
:-------------------------:|:-------------------------:
![Light mode](https://raw.githubusercontent.com/526avijitgupta/gokarna/main/images/screenshot-light-list.png "Light mode") | ![Dark mode](https://raw.githubusercontent.com/526avijitgupta/gokarna/main/images/screenshot-dark-list.png "Dark mode")

## Installation

Follow the steps in [Theme Documentation - Basics](https://gokarna-hugo.netlify.app/posts/theme-documentation-basics/#installation).

```sh
git submodule add https://github.com/gokarna-theme/gokarna-hugo.git themes/gokarna
```

## Customization

For a complete guide on customization, please consult the [basic](https://gokarna-hugo.netlify.app/posts/theme-documentation-basics/) and [advanced](https://gokarna-hugo.netlify.app/posts/theme-documentation-advanced/) documentation.

Examples include:

- [Add an avatar](https://gokarna-hugo.netlify.app/posts/theme-documentation-basics/#avatar-url) and [change its size](https://gokarna-hugo.netlify.app/posts/theme-documentation-basics/#avatar-size)
- [Add text to the footer](https://gokarna-hugo.netlify.app/posts/theme-documentation-basics/#footer)
- [Change how dates are formatted on posts](https://gokarna-hugo.netlify.app/posts/theme-documentation-basics/#date-format)
- [Choose the syntax highlighting color scheme](https://gokarna-hugo.netlify.app/posts/theme-documentation-advanced/#syntax-highlighting)
- [Compose navigation menu items](https://gokarna-hugo.netlify.app/posts/theme-documentation-basics/#basic-configuration)
- [Define the site's accent color](https://gokarna-hugo.netlify.app/posts/theme-documentation-basics/#accent-color)
    Change the color of hyperlinks, including icons.
- [Display recent or popular posts on the home page](https://gokarna-hugo.netlify.app/posts/theme-documentation-basics/#display-posts-on-the-home-page)
- [Inject custom HTML](https://gokarna-hugo.netlify.app/posts/theme-documentation-basics/#custom-head-html)
    Use the `<head>` and `<footer>` elements to add arbitrary HTML, JavaScript, and CSS.

## Translations

Change [`languageCode`](https://gohugo.io/content-management/multilingual/#configure-languages) to use one of [our translations](https://github.com/gokarna-theme/gokarna-hugo/tree/main/i18n).

Missing a language? Make Gokarna multilingual by [creating a translation table](https://gohugo.io/functions/lang/translate/#simple-translations).

## 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 of India.

![Gokarna](https://raw.githubusercontent.com/526avijitgupta/gokarna/main/images/gokarna.jpg)

## Performance

Google Lighthouse score: 100%

![Lighthouse Score](https://raw.githubusercontent.com/526avijitgupta/gokarna/main/images/lighthouse.png)

## LICENSE

This code is licensed under [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.html)