English README | 简体中文说明

KeepIt is a clean, elegant but advanced blog theme for Hugo.

It is based on the original LeaveIt Theme and KeepIt Theme.

Since the three themes have a similar look, if you have questions about their differences, read Why choose KeepIt so that you can choose the one that works best for you.

To see this theme in action, here is a live demo site which is rendered with KeepIt theme.

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 or algolia
• Copy code to clipboard with one click
• Extended Markdown syntax for Font Awesome icons
• Extended Markdown syntax for ruby annotation
• Extended Markdown syntax for fraction
• Mathematical formula supported by KaTeX
• Diagram syntax shortcode supported by mermaid
• Interactive data visualization shortcode supported by ECharts
• Mapbox shortcode supported by Mapbox GL JS
• Embedded music player supported by APlayer and 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 ❤️!

• Optimized for performance: 99/100 on mobile and 100/100 on desktop in Google PageSpeed Insights
• Optimized SEO performance with a correct SEO SCHEMA based on JSON-LD
• Google Analytics supported
• Fathom Analytics supported
• Search engine verification supported (Google, Bind, Yandex and Baidu)
• CDN for third-party libraries supported
• Automatically converted images with Lazy Load by lazysizes

• 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

• Gravatar supported by Gravatar
• Local Avatar supported
• Up to 64 social links supported
• Up to 24 share sites supported
• Disqus comment system supported by Disqus
• Gitalk comment system supported by Gitalk
• Valine comment system supported by Valine
• Facebook comments system supported by Facebook
• Telegram comments system supported by Telegram Comments
• Commento comment system supported by Commento
• Utterances comment system supported by Utterances

• Search supported by Lunr.js or algolia
• Twemoji supported
• Automatically highlighting code
• Copy code to clipboard with one click
• Images gallery supported by lightGallery
• Extended Markdown syntax for Font Awesome icons
• Extended Markdown syntax for ruby annotation
• Extended Markdown syntax for fraction
• Mathematical formula supported by KaTeX
• Diagrams shortcode supported by mermaid
• Interactive data visualization shortcode supported by ECharts
• Mapbox shortcode supported by Mapbox GL JS
• Music player shortcode supported by APlayer and MetingJS
• Bilibili player shortcode
• Kinds of admonitions shortcode
• Custom style shortcode
• Custom script shortcode
• Animated typing supported by TypeIt
• Cookie consent banner supported by cookieconsent
• ...

Build Documentation Locally:

hugo server --source=exampleSite

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

Languages Compatibility

All feedback is welcome! Head over to the issue tracker.

KeepIt is licensed under the MIT license. Check the LICENSE file for details.

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

• normalize.css
• Font Awesome
• Simple Icons
• Animate.css
• autocomplete
• Lunr.js
• algoliasearch
• lazysizes
• object-fit-images
• Twemoji
• emoji-data
• lightGallery
• clipboard.js
• Sharer.js
• TypeIt
• KaTeX
• mermaid
• ECharts
• Mapbox GL JS
• APlayer
• MetingJS
• Gitalk
• Valine
• cookieconsent

Dillon

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

• PayPal
• Alipay
• Wechat

Thanks! ❤️