Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/khusika/feelit

A clean, elegant but advanced blog theme for Hugo
https://github.com/khusika/feelit

hugo hugo-theme

Last synced: about 1 month ago
JSON representation

A clean, elegant but advanced blog theme for Hugo

Awesome Lists containing this project

README 

        
# FeelIt Theme | Hugo [![Netlify Status](https://api.netlify.com/api/v1/badges/6c8cd9a1-4916-4705-b286-dce0930b9217/deploy-status)](https://app.netlify.com/sites/hugofeelit/deploys)



[![GitHub release (latest by date)](https://img.shields.io/github/v/release/khusika/FeelIt?style=flat-square)](https://github.com/khusika/FeelIt/releases)

[![Hugo](https://img.shields.io/badge/Hugo-%5E0.110.0-ff4088?style=flat-square&logo=hugo)](https://gohugo.io/)

[![License](https://img.shields.io/github/license/khusika/FeelIt?style=flat-square)](https://github.com/khusika/FeelIt/blob/main/LICENSE)



> **FeelIt** is a **clean**, **elegant** but **advanced** blog theme for [Hugo](https://gohugo.io/).



It is based on the original [LoveIt Theme](https://github.com/dillonzq/LoveIt), [LeaveIt Theme](https://github.com/liuzc/LeaveIt) and [KeepIt Theme](https://github.com/Fastbyte01/KeepIt).



Since the three themes have a similar look, if you have questions about their differences,

read [Why choose FeelIt](#why-choose-feelit) so that you can choose the one that works best for you.



![Hugo Theme FeelIt](https://github.com/khusika/FeelIt/raw/main/images/screenshot.png)



## Demo Site



To see this theme in action, here is a live [demo site](https://feelit.khusika.dev/) which is rendered with **FeelIt** theme.



## Why choose FeelIt



Compared to the original LoveIt theme, LeaveIt theme and the KeepIt theme. The FeelIt theme has the following modifications.



* Custom **Header**

* Custom **CSS Style**

* A new **home page**, compatible with the latest version of Hugo

* A lot of **style detail adjustments,** including color, font size, margins, code preview style

* More readable **dark mode**

* Some beautiful **CSS animations**

* Easy-to-use and self-expanding **table of contents**

* More **social links**, **share sites** and **comment system**

* **Search** supported by [Lunr.js](https://lunrjs.com/) or [algolia](https://www.algolia.com/)

* **Copy code** to clipboard with one click

* Extended Markdown syntax for **[Font Awesome](https://fontawesome.com/) icons**

* Extended Markdown syntax for **ruby annotation**

* Extended Markdown syntax for **fraction**

* **Mathematical formula** supported by [KaTeX](https://katex.org/)

* **Diagram syntax** shortcode supported by [mermaid](https://github.com/knsv/mermaid)

* **Interactive data visualization** shortcode supported by [ECharts](https://echarts.apache.org/)

* **Mapbox** shortcode supported by [Mapbox GL JS](https://docs.mapbox.com/mapbox-gl-js)

* Embedded **music player** supported by [APlayer](https://github.com/MoePlayer/APlayer) and [MetingJS](https://github.com/metowolf/MetingJS)

* **Bilibili** player supported

* Kinds of **admonitions** shortcode supported

* Custom style shortcodes supported

* **CDN** for all third-party libraries supported

* ...



In short,

if you prefer the design language and freedom of the FeelIt theme,

if you want to use the extended Font Awesome icons conveniently,

if you want to embed mathematical formulas, flowcharts, music or Bilibili videos in your posts,

the FeelIt theme may be more suitable for you.



I hope you will FeelIt ❤️!



## Features



### Performance and SEO



* Optimized for **performance**: 99/100 on mobile and 100/100 on desktop in [Google PageSpeed Insights](https://developers.google.com/speed/pagespeed/insights)

* Optimized SEO performance with a correct **SEO SCHEMA** based on JSON-LD

* **[Google Analytics](https://analytics.google.com/analytics)** supported

* **[Fathom Analytics](https://usefathom.com/)** supported

* **[GoatCounter Analytics](https://www.goatcounter.com/)** supported

* Search engine **verification** supported (Google, Bind, Yandex and Baidu)

* **CDN** for third-party libraries supported

* Automatically converted images with **Lazy Load** by [lazysizes](https://github.com/aFarkas/lazysizes)



### Appearance and Layout



* **Responsive** layout

* **Light/Dark** mode

* Globally consistent **design language**

* **Pagination** supported

* Easy-to-use and self-expanding **table of contents**

* **Multilanguage** supported and i18n ready

* Beautiful **CSS animation**



### Social and Comment Systems



* **Gravatar** supported by [Gravatar](https://gravatar.com)

* Local **Avatar** supported

* Up to **64** social links supported

* Up to **28** share sites supported

* **Disqus** comment system supported by [Disqus](https://disqus.com)

* **Gitalk** comment system supported by [Gitalk](https://github.com/gitalk/gitalk)

* **Valine** comment system supported by [Valine](https://valine.js.org/)

* **Facebook comments** system supported by [Facebook](https://developers.facebook.com/docs/plugins/comments/)

* **Telegram comments** system supported by [Telegram Comments](https://comments.app/)

* **Commento** comment system supported by [Commento](https://commento.io/)

* **Utterances** comment system supported by [Utterances](https://utteranc.es/)



### Extended Features



* **Search** supported by [Lunr.js](https://lunrjs.com/) or [algolia](https://www.algolia.com/)

* **Twemoji** supported

* Automatically **highlighting** code

* **Copy code** to clipboard with one click

* **Images gallery** supported by [lightgallery.js](https://github.com/sachinchoolur/lightgallery.js)

* Extended Markdown syntax for **[Font Awesome](https://fontawesome.com/) icons**

* Extended Markdown syntax for **ruby annotation**

* Extended Markdown syntax for **fraction**

* **Mathematical formula** supported by [KaTeX](https://katex.org/)

* **Diagrams** shortcode supported by [mermaid](https://github.com/knsv/mermaid)

* **Interactive data visualization** shortcode supported by [ECharts](https://echarts.apache.org/)

* **Mapbox** shortcode supported by [Mapbox GL JS](https://docs.mapbox.com/mapbox-gl-js)

* **Music player** shortcode supported by [APlayer](https://github.com/MoePlayer/APlayer) and [MetingJS](https://github.com/metowolf/MetingJS)

* **Bilibili player** shortcode

* Kinds of **admonitions** shortcode

* **Custom style** shortcode

* **Custom script** shortcode

* **Animated typing** supported by [TypeIt](https://typeitjs.com/)

* **Cookie consent banner** supported by [cookieconsent](https://github.com/osano/cookieconsent)

* ...



## Documentation



* ### [Theme Documentation - Basics](https://feelit.khusika.dev/theme-documentation-basics/)



* ### [Theme Documentation - Content](https://feelit.khusika.dev/theme-documentation-content/)



* ### [Theme Documentation - Built in Shortcodes](https://feelit.khusika.dev/theme-documentation-built-in-shortcodes/)



* ### [Theme Documentation - Extended Shortcodes](https://feelit.khusika.dev/theme-documentation-extended-shortcodes/)



* ### [Basic Markdown Syntax](https://feelit.khusika.dev/basic-markdown-syntax/)



* ### [Emoji Support](https://feelit.khusika.dev/emoji-support/)



## Getting Started



* Install required packages

```bash

npm run reinstall

```



* Debug theme documentation

```bash

npm run start-production

```



* Build theme documentation

```bash

npm run build

```



## Multilingual and i18n



FeelIt supports the following languages:



* German

* English

* Spanish

* French

* Indonesian

* Italian

* Polish

* Brazilian Portuguese

* Romanian

* Russian

* Serbian

* Vietnamese

* Simplified Chinese

* Hungarian

* Czech

* Persian

* Ukrainian

* [Contribute with a new language](https://github.com/khusika/FeelIt/pulls)



[Languages Compatibility](https://feelit.khusika.dev/theme-documentation-basics/#language-compatibility)



## Questions, ideas, bugs, pull requests



All feedback is welcome! Head over to the [issue tracker](https://github.com/khusika/FeelIt/issues).



## License



FeelIt is licensed under the **MIT** license. Check the [LICENSE file](https://github.com/khusika/FeelIt/blob/main/LICENSE) for details.



Thanks to the authors of following resources included in the theme:



* [modern-normalize](https://github.com/sindresorhus/modern-normalize)

* [Font Awesome](https://fontawesome.com/)

* [Simple Icons](https://github.com/simple-icons/simple-icons)

* [Animate.css](https://daneden.github.io/animate.css/)

* [autocomplete.js](https://github.com/algolia/autocomplete.js)

* [Lunr.js](https://lunrjs.com/)

* [algoliasearch](https://github.com/algolia/algoliasearch-client-javascript)

* [lazysizes](https://github.com/aFarkas/lazysizes)

* [object-fit-images](https://github.com/fregante/object-fit-images)

* [Twemoji](https://github.com/twitter/twemoji)

* [lightgallery.js](https://github.com/sachinchoolur/lightgallery.js)

* [clipboard.js](https://github.com/zenorocha/clipboard.js)

* [Sharer.js](https://github.com/ellisonleao/sharer.js)

* [TypeIt](https://typeitjs.com/)

* [KaTeX](https://katex.org/)

* [mermaid](https://github.com/knsv/mermaid)

* [ECharts](https://echarts.apache.org/)

* [Mapbox GL JS](https://docs.mapbox.com/mapbox-gl-js)

* [APlayer](https://github.com/MoePlayer/APlayer)

* [MetingJS](https://github.com/metowolf/MetingJS)

* [Gitalk](https://github.com/gitalk/gitalk)

* [Valine](https://valine.js.org/)

* [cookieconsent](https://github.com/osano/cookieconsent)



## Author



[Khusika](https://khusika.dev) and [all contributors](https://github.com/khusika/FeelIt/graphs/contributors)



Thanks! ❤️