OpenSource/LoveIt
1
0
Fork 0
mirror of https://github.com/dillonzq/LoveIt.git synced 2024-11-13 02:16:19 +01:00
Code Issues Projects Releases Packages Wiki Activity
LoveIt/README.md

6.2 KiB
Raw Blame History

LoveIt Theme | Hugo

中文 README

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

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

Hugo Theme LoveIt

Demo

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

Websites using LoveIt theme:

Features

  • Optimized for performance: 99/100 on mobile and 100/100 on desktop in Google PageSpeed Insights
  • Desktop / Mobile layouts support
  • Dark / Light mode
  • Optimized SEO performance with a correct SEO SCHEMA based on JSON-LD
  • A More coerent style beetwen page and sections
  • Multilanguage support and I18N ready
  • Pagination support
  • Google Analytics support
  • Disqus comment system support by Disqus
  • Gitalk comment system support by Gitalk
  • Valine comment system support by Valine
  • Gravatar support by Gravatar
  • Local Avatar support
  • Up to 54 social sites supported
  • Share post support
  • Search engine verification support (Google, Bind, Yandex and Baidu)
  • Automatically converted images with Lazy Load by lazysizes
  • Automatically highlighting code by chroma in Hugo
  • Extended markdown syntax for Font Awesome icons
  • Math formula support by Katex
  • Diagram syntax shortcode support by mermaid
  • Embedded music player support by APlayer and MetingJS
  • Bilibili player support
  • Kinds of admonitions shortcode support
  • Custom align and float style shortcodes support
  • Animated typing support by TypeIt
  • Animated coutdown support by jQuery.countdown
  • Dynamic to top support by Smooth Scroll
  • CDN support
  • ...

Getting Started

Clone this repository to your hugo theme directory.

  cd themes
  git clone https://github.com/dillonzq/LoveIt.git

Or, make this repository a submodule of your site directory.

  git submodule add https://github.com/dillonzq/LoveIt.git themes/LoveIt

Next, open config.toml in the base of the Hugo site and ensure the theme option is set to KeepIt:

  theme = "LoveIt"

For more information read the official setup guide of Hugo.

Site Configuration

Take a look in the exampleSite folder.

This directory contains an example config file and the content for the demo for en and zh languages. It serves as an example setup for your website.

Copy the config.toml to the root directory of your website. Overwrite the existing config file if necessary.

Content Suggestions

A few suggestions to help you get a good looking site quickly:

  • Keep blog posts in the content/posts directory, for example: content/posts/my-first-post.md
  • Keep static pages in the content directory, for example: content/about.md
  • Keep media like images in the static directory, for example: static/images/2019/9/screenshot.png

Customizing styles for your website

If you want to change some styling to fit your own website needs, you can edit them:

  • assets/css/_varibales.scss: You can override the variables in _variables.scss to customize the style
  • assets/css/_custom.scss: You can put your custom css in this file

Favicons, Browserconfig, Manifest

It is recommended to put your own favicons

  • apple-touch-icon.png (180x180)
  • favicon-32x32.png (32x32)
  • favicon-16x16.png (16x16)
  • mstile-150x150.png (150x150)
  • android-chrome-192x192.png (192x192)
  • android-chrome-512x512.png (512x512)

into /static. They’re easily created via https://realfavicongenerator.net/.

Customize browserconfig.xml and site.webmanifest to set theme-color and background-color.

Tips

Set production environment when generating site

Because some features are only in production mode, so you need to add a production environment variables when generating your site.

  HUGO_ENV=production hugo --gc --minify

How to toggle dark-light mode

  • You can click the circle icon to toggle dark-light mode. In the desktop version the circle icon is to the right and in the mobile version is positioned to the left, close to the site title.
  • If you want to make your own theme toggle-able element, you can create an element with a class .theme-switch. See here

Home Post model

If you want to show posts on index instead of a personal profile, just open config.toml, add the following line:

  [params]
    home_mode = "post"

Add logo and cover for SEO

Add a logo image (127x40) and a cover image (800x600) in the static directory.

Questions, ideas, bugs, pull requests

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

License

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

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

Author

Dillon