HugoBlog

KeepIt — Hugo Blog Template

By Fastbyte01

KeepIt is a Hugo-based blog theme derived from the LeaveIt and KeepIt projects. It is MIT-licensed and provides light/dark mode, multilingual support, search, and various extended Markdown shortcodes.

Open Source SiteDownload Source ZIP

Explore the design

Compare the page layouts and mobile experience. Open any screenshot for a closer look.

3 previews
Desktop homepage1 / 3
Desktop captureTop of page

Actual screenshot captured by the server browser.

All pages & views 3

Screenshots show visual appearance; interactive behavior may differ.

Recorded 2026-10-02View source

What stands out

A quick read of the recorded project description.

01

Hugo-based blog theme derived from the LeaveIt and KeepIt projects, with adjustments to the header, homepage, and style details

02

Supports light/dark mode, responsive layout, pagination, expandable table of contents, and multilingual i18n

03

Supports Lunr.js or Algolia search, as well as comment systems such as Disqus, Gitalk, Valine, and Utterances

04

Provides shortcodes for KaTeX math formulas, mermaid diagrams, ECharts data visualizations, Mapbox maps, APlayer music player, and Bilibili player

05

Supports extended Markdown syntax such as Font Awesome icons, ruby annotations, and fractions, plus code highlighting and one-click copy

06

Licensed under MIT, allowing free use, modification, commercial use, and distribution of this version of the code

Template Details

KeepIt is a blog theme for Hugo, hosted at Fastbyte01/KeepIt and licensed under MIT. The README states that it is modified from the LeaveIt and KeepIt themes, with adjustments to the header, CSS styles, homepage, color scheme and font sizes, code preview styles, dark mode readability, CSS animations, table of contents, social links, sharing sites, and comment systems.

The theme's features cover three areas: appearance and layout, social and comments, and extended content. For appearance, it supports responsive layouts for desktop and mobile, light/dark mode, pagination, expandable table of contents, multilingual support and i18n. For social and comments, it supports Gravatar or local avatars, up to 64 social links, up to 24 sharing sites, and comment systems such as Disqus, Gitalk, Valine, Facebook, Telegram, Commento, and Utterances. For extended content, it supports Lunr.js or Algolia search, Twemoji, code highlighting with one-click copy, lightGallery image galleries, and shortcodes or extended syntax for Font Awesome icons, ruby annotations, fractions, KaTeX math formulas, mermaid diagrams, ECharts data visualizations, Mapbox maps, APlayer and MetingJS music players, Bilibili players, admonitions, custom styles and scripts, TypeIt typing animations, and cookieconsent banners.

Regarding usage constraints, the theme depends on JavaScript assets that must be compiled first: run npm install and npm run build (or npm run start to launch a live server) in the theme directory to generate assets such as assets/js/theme.js for Hugo to use. To build the documentation locally, run hugo server --source=exampleSite. The third-party libraries and assets listed in the README (such as fonts, icons, galleries, players, and comment services) each have their own licenses; the MIT license for the code does not cover these external assets and services. External services such as domain, hosting, comments, search, and maps may incur additional fees. The README does not state production readiness or performance guarantees; it only mentions a score on Google PageSpeed Insights, which is not repeated here as a promise.

HugoBlog

Is it right for your project?

Use Cases

  • Building a personal blog with Hugo and wanting basic reading features such as light/dark mode, table of contents, and pagination
  • Embedding technical content such as math formulas, flowcharts, data visualization charts, or maps in articles
  • Writing scenarios that require embedding a music player or Bilibili video in blog posts
  • Blog sites that want to configure multiple social links, share buttons, and comment systems
  • Hugo sites that need multilingual support or i18n readiness

Suitable For

  • Individual authors using Hugo who prefer a clean blog layout
  • Technical writers who need to use extended Markdown syntax and shortcodes in articles
  • Blog maintainers who want to choose their own comment system and search solution
  • Hugo users who accept running an npm build process in the theme directory

Getting started & customization

Use these recorded setup notes alongside the repository instructions for your chosen version.

  1. 1

    The theme depends on JavaScript assets that need to be compiled; run npm install and npm run build (or npm run start to launch a live server) in the theme directory to generate files such as assets/js/theme.js

  2. 2

    To build the documentation locally, run hugo server --source=exampleSite

  3. 3

    External services such as search, comments, maps, and analytics require applying for and configuring the corresponding parameters yourself

  4. 4

    Demo images, fonts, icons, and other third-party assets must be checked against their respective licenses; the MIT license for the code does not cover these assets

  5. 5

    When distributing copies or substantial portions of the code, retain the original author's copyright notice and the full MIT license notice

Read repository instructions

License & source material

Usage conditions & limitations

Free to use · keep license notice

This entry covers the free version under the MIT license in the public repository; the free scope is for this version of the code and does not mean external services or third-party assets are free.

Must comply with when using

  • Free use, modification, commercial use, and distribution of this version of the code are allowed.
  • When distributing copies or substantial portions of the code, retain the original author's copyright notice and the full MIT license notice.
  • The code is provided as is; warranties and limitations of liability are governed by the original license and applicable law.

Additional costs & items to verify

  • Before use, you must run npm install and npm run build (or npm run start) in the theme directory to compile JavaScript assets and generate files such as assets/js/theme.js; otherwise Hugo cannot use the theme properly.
  • Search functionality depends on external services such as Lunr.js or Algolia; if you choose Algolia, you need to register an account and configure API keys yourself, which may incur additional costs.
  • The Mapbox map shortcode depends on the external Mapbox GL JS service; before use, you need to apply for a Mapbox account and access token, and charges may apply after exceeding the free quota.
  • The Disqus comment system is a third-party external service; you need to register an account and embed its script, which may involve ads or paid plans.
  • Google Analytics requires registering a Google account and configuring a tracking ID; it is an external service.
  • The theme includes many third-party resources such as normalize.css, Font Awesome, KaTeX, mermaid, ECharts, and APlayer, each under its own license; the MIT license does not cover these assets, and you must check each one before distribution or commercial use.
  • The README provides sponsorship channels such as PayPal, Alipay, and WeChat; these are voluntary donations and do not affect free use under the MIT license.
  • Demo images, fonts, icons, and other third-party assets must be checked against their respective licenses; they cannot be judged solely by the code's MIT license.
  • External services such as domain, hosting, database, payment, or AI may incur additional fees.
View Original Text Basis

Permission is hereby granted, free of charge

Original License Text

This theme relies on JavaScript assets that need to be compiled before Hugo can use them. From the theme directory run:

Original README

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

Original README

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

Original README

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

Original README

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

Original README

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

Original README

If you enjoy the theme, please consider buying me a coffee ☕️.

Original README
https://github.com/Fastbyte01/KeepIt/blob/master/LICENSEhttps://github.com/Fastbyte01/KeepIt/blob/master/README.md

Compiled by DeepSeek based on repository license and README ·2026-10-02. Results only cover the materials read; dependencies, images, fonts, and subsequent term changes are subject to their respective original texts.

Project checks & description sources

Template Information

Source platforms
Hugo Themes
Documentation and maintenance reference score
More documented · 85 / 100
Technologies
Hugo
Website type
Blog
How this score is calculated

Our heuristic uses license records (up to 30), a demo link (12), a preview (10), stars (15), recorded maintenance (15), description completeness (8), feature records (5) and classification data (5). It is not a code, security or performance test, or a Google score. A link does not establish tested functionality.

What to verify for this project

Repository update recorded
2025-06-27
Screenshot last checked
2026-10-02

A demo link is listed. Check it with your own content and viewport sizes; its presence does not confirm that forms, authentication or payments work.

The catalog identifies Hugo as the primary stack. Check the actual dependency manifest and lockfile for versions and hosting requirements. These notes use recorded metadata, not a code audit or a deployment test.

Use a selection guide →

How this description was prepared

AI-assisted description based on catalog records and repository material. Repository authors are not automatically the reviewers of this description.

Automatically checked against source and license rules; no manual editorial review.

Inspect the recorded source material

SHA-256: b36b5f84169e76c05a5d7061596910d9360ed1089bca5ca9b75d19705ccc98cd

2026-10-02T16:35:56.683Z

Source file / repository
# KeepIt Theme | Hugo [![Netlify Status](https://api.netlify.com/api/v1/badges/e60303f2-862c-4342-bf59-7c9adb10812e/deploy-status)](https://app.netlify.com/sites/hugo-keepit/deploys)

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/dillonzq/KeepIt?style=flat-square)](https://github.com/Fastbyte01/KeepIt/releases)
[![Hugo](https://img.shields.io/badge/Hugo-%5E0.62.0-ff4088?style=flat-square&logo=hugo)](https://gohugo.io/)
[![License](https://img.shields.io/github/license/dillonzq/KeepIt?style=flat-square)](https://github.com/Fastbyte01/KeepIt/blob/master/LICENSE)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=dillonzq_KeepIt&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=dillonzq_KeepIt)
[![CircleCI](https://circleci.com/gh/dillonzq/KeepIt/tree/master.svg?style=svg)](https://circleci.com/gh/dillonzq/KeepIt/tree/master)

English README | [简体中文说明](https://github.com/Fastbyte01/KeepIt/blob/master/README.zh-cn.md)

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

It is based on the original [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 KeepIt](#why-choose-keepit) so that you can choose the one that works best for you.

![Hugo Theme KeepIt](https://github.com/Fastbyte01/KeepIt/raw/master/images/Apple-Devices-Preview.png)

## [Demo Site](https://suspicious-archimedes-ab369d.netlify.app/)

To see this theme in action, here is a live [demo site](https://suspicious-archimedes-ab369d.netlify.app/) which is rendered with **KeepIt** theme.

## Why choose KeepIt

Compared to the original LeaveIt theme and the KeepIt theme, the KeepIt 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/mermaid-js/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 KeepIt 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 KeepIt theme may be more suitable for you.

I hope you will KeepIt ❤️!

## 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
* Search engine **verification** supported (Google, Bing, 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

* **Desktop/Mobile 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 **24** 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](https://github.com/sachinchoolur/lightgallery)
* 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/mermaid-js/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](https://suspicious-archimedes-ab369d.netlify.app/categories/documentation/)

Build Documentation Locally:

```bash
hugo server --source=exampleSite
```

## Install dependencies and build assets

This theme relies on JavaScript assets that need to be compiled before Hugo can
use them. From the theme directory run:

```bash
npm install
npm run build       # or `npm run start` for a live server
```

These commands generate `assets/js/theme.js` and other resources consumed by
Hugo.

## Multilingual and i18n

KeepIt supports the following languages:

* English
* Simplified Chinese
* Traditional Chinese
* French
* Polish
* Brazilian Portuguese
* Italian
* Spanish
* German
* Serbian
* Russian
* Romanian
* Vietnamese
* [Contribute with a new language](https://github.com/Fastbyte01/KeepIt/pulls)

[Languages Compatibility](https://suspicious-archimedes-ab369d.netlify.app/theme-documentation-basics/#language-compatibility)

## [Roadmap](https://github.com/Fastbyte01/KeepIt/projects/1)

## Questions, ideas, bugs, pull requests

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

## License

KeepIt is licensed under the **MIT** license. Check the [LICENSE file](https://github.com/Fastbyte01/KeepIt/blob/master/LICENSE) for details.

## Special Thanks

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

* [normalize.css](https://github.com/necolas/normalize.css)
* [Font Awesome](https://fontawesome.com/)
* [Simple Icons](https://github.com/simple-icons/simple-icons)
* [Animate.css](https://daneden.github.io/animate.css/)
* [autocomplete](https://github.com/algolia/autocomplete)
* [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)
* [emoji-data](https://github.com/iamcal/emoji-data)
* [lightGallery](https://github.com/sachinchoolur/lightgallery)
* [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/mermaid-js/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

[Dillon](https://dillonzq.com)

## Sponsor

If you enjoy the theme, please consider buying me a coffee ☕️.

* [PayPal](https://paypal.me/dillonzq)
* [Alipay](https://github.com/Fastbyte01/KeepIt/raw/master/images/Alipay.jpg)
* [Wechat](https://github.com/Fastbyte01/KeepIt/raw/master/images/Wechat.jpg)

Thanks! ❤️

## Stargazers over time

[![Stargazers over time](https://starchart.cc/dillonzq/KeepIt.svg)](https://starchart.cc/dillonzq/KeepIt)
Report a correction

Explore similar templates

Compare previews and descriptions within the same stack and category.

hugo-PaperMod

hugo-PaperMod

A fast, clean, responsive Hugo theme for blogs and lightweight portfolios, with three layout modes (Regular, Home-Info, Profile), automatic and manual light/dark themes, Fuse.js client-side search, multilingual support, and built-in Open Graph, Twitter Cards, and Schema.org data.

Hugo · Portfolio

LoveIt

LoveIt

LoveIt is a clean, elegant, and feature-rich Hugo blog theme derived from LeaveIt and KeepIt, MIT-licensed. It offers light/dark modes, responsive layout, multilingual support, and search via Lunr.js or Algolia.

Hugo · Blog

hugo-coder

hugo-coder

hugo-coder is a minimalist Hugo blog theme maintained by luizdepra under the MIT license. It provides a clean, text-focused blog appearance, configuration documentation in the docs directory, and a complete exampleSite with hugo.toml.

Hugo · Blog

blowfish

blowfish

Blowfish is a Hugo personal website and blog theme built with Tailwind CSS 4, focused on lightness, simplicity, and content-first presentation.

Hugo · Blog

hugo-paper

hugo-paper

hugo-paper is a simple, clean, and customizable Hugo blog theme configured through config.toml or hugo.toml.

Hugo · Blog

hextra

hextra

Hextra is a Hugo theme for documentation and blog sites, built on Hugo and Tailwind CSS with design referencing Nextra.

Hugo · Documentation