OpenSource/LoveIt
1
0
Fork 0
mirror of https://github.com/dillonzq/LoveIt.git synced 2024-11-22 14:56:19 +01:00
Code Issues Projects Releases Packages Wiki Activity
❤️A clean, elegant but advanced blog theme for Hugo 一个简洁、优雅且高效的 Hugo 主题 https://hugoloveit.com/
326 commits 3 branches 17 tags 242 MiB
JavaScript 95.5%
HTML 2.6%
SCSS 1.4%
CSS 0.5%
Find a file
Dillon 315eb094e5 Squashed commit of the following: 
commit 6430e78c16
Merge: 5855527 b13bbc3
Author: Dillon <dillonzq@outlook.com>
Date:   Wed Feb 19 19:31:28 2020 +0800

    Merge pull request #84 from dillonzq/fix/duplicated_typeit

    fix(typeit): fix duplicated typeit bug (#82)

commit b13bbc368c
Author: Dillon <dillonzq@outlook.com>
Date:   Wed Feb 19 19:25:49 2020 +0800

    fix(typeit): fix duplicated typeit bug (#82)

commit 58555274f5
Merge: 16320fa 02919a7
Author: Dillon <dillonzq@outlook.com>
Date:   Wed Feb 19 18:59:21 2020 +0800

    Merge pull request #83 from dillonzq/fix/social_link_href

    fix(social): fix social link bug (#81)

commit 02919a7d48
Author: Dillon <dillonzq@outlook.com>
Date:   Wed Feb 19 18:55:40 2020 +0800

    fix(social): fix social link bug (#81)
2020-02-20 11:55:52 +08:00
.circleci fix(check): fix some html check bugs 2020-02-18 16:22:24 +08:00
archetypes feat(home): improve default behavior of hiddenFromHomePage 2020-02-17 12:44:04 +08:00
assets Squashed commit of the following: 2020-02-20 11:55:52 +08:00
exampleSite Squashed commit of the following: 2020-02-20 11:55:52 +08:00
i18n feature(share): support 28 kinds of share links 2020-02-18 02:53:07 +08:00
images
layouts Squashed commit of the following: 2020-02-20 11:55:52 +08:00
resources/_gen/assets/scss/css Squashed commit of the following: 2020-02-20 11:55:52 +08:00
src/js fix(toc): fix toc script bug 2020-02-18 17:52:19 +08:00
static fix(toc): fix toc script bug 2020-02-18 17:52:19 +08:00
.babelrc chore(hook): add babel pre-commit hook 2020-02-17 00:41:08 +08:00
.gitignore chore(hook): add babel pre-commit hook 2020-02-17 00:41:08 +08:00
LICENSE
package-lock.json chore(hook): add babel pre-commit hook 2020-02-17 00:41:08 +08:00
package.json chore(config): update config name 2020-02-17 02:32:52 +08:00
README.md chore(readme): update readme 2020-02-16 03:04:32 +08:00
README.zh.md chore(header): remove all dummy-targets and update smooth scroll 2020-02-16 16:42:14 +08:00
theme.toml feat(exampleSite): add some posts to exampleSite 2020-02-01 19:47:58 +08:00

README.md

LoveIt Theme | Hugo

Netlify Status

English README | 中文说明

LoveIt 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 LoveIt so that you can choose the one that works best for you.

Hugo Theme LoveIt

Demo Site

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

Why choose LoveIt

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

  • Fixed title bar
  • System native fonts
  • Home subtitles typewriter effect
  • A new list of home posts, compatible with the latest version of Hugo
  • Replace all theme icons with Font Awesome
  • 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 article catalog, while adapting to the mobile side
  • More suitable as a blog theme, the gallery function has been removed, but the image is lazy loaded to improve performance
  • 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
  • CDN for all third-party libraries support

In short, if you prefer the design language and freedom of the LoveIt theme, if you want to use the extended Font Awesome icons conveniently, if you want to embed math formulas, flowcharts, music or Bilibili videos in your posts, the LoveIt theme may be more suitable for you.

I hope you will LoveIt ❤️!

Features

Performance and SEO

  • 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 support
  • Search engine verification support (Google, Bind, Yandex and Baidu)
  • CDN for all third-party libraries support
  • Automatically converted images with Lazy Load by lazysizes

Appearance and Layout

  • Desktops/Mobiles Responsive layout
  • Dark/Light Mode
  • A More coerent style beetwen page and sections
  • Pagination support
  • Easy-to-use and self-expanding article catalog, while adapting to the mobile side
  • Multilanguage support and I18N ready
  • Beautiful CSS animation

Social and Comment Systems

  • Gravatar support by Gravatar
  • Local Avatar support
  • Up to 54 social sites supported
  • Share post support
  • Disqus comment system support by Disqus
  • Gitalk comment system support by Gitalk
  • Valine comment system support by Valine
  • Facebook comment system support by Facebook

Extended Features

  • 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
  • Dynamic to top support by Smooth Scroll
  • ...

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