Skip to content
This repository was archived by the owner on Mar 9, 2022. It is now read-only.

Commit

Permalink
feat: KeepIt => LoveIt
Browse files Browse the repository at this point in the history
  • Loading branch information
dillonzq committed Aug 6, 2019
1 parent 7218a98 commit 96029ea
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 48 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ $RECYCLE.BIN/
# OSX
.DS_Store

# Linux
# Linux
.directory
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
The MIT License (MIT)

Copyright (c) 2018 LIUZHICHAO.COM
Copyright (c) 2019 DILLONZQ.TOP
Copyright (c) 2019 DILLONZQ.COM

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down
85 changes: 48 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
KeepIt Hugo Theme
========================
# LoveIt Hugo Theme

KeepIt is a clean, elegant, simple but not simpler blog theme for Hugo based on the original [LeaveIt Theme](https://raw.githubusercontent.com/liuzc/LeaveIt/) developed by [LiuZhichao](https://raw.githubusercontent.com/liuzc/).
LoveIt is a clean, elegant, simple but not simpler blog theme for Hugo based on the original [LeaveIt Theme](https://github.com/liuzc/LeaveIt/) and [KeepIt Theme](https://github.com/liuzc/LeaveIt/) developed by [Dillon](https://dillonzq.com).

![hugo-theme-KeepIt](https://github.com/Fastbyte01/KeepIt/blob/master/images/screenshot.png)
![hugo-theme-LoveIt](https://github.com/dillonzq/LoveIt/blob/master/images/screenshot.png)

## Demo

# Demo
To see this theme in action, Here is a live [demo site](https://suspicious-archimedes-ab369d.netlify.com) which is rendered with this theme.

People that are using **KeepIt**:
People that are using **LoveIt**:

* [PapEr](https://page.codespaper.com)
* [SilkeHenderickx](http://www.silkehenderickx.be)
* [Dillon](https://dillonzq.com)

# Features
## Features

* 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
Expand All @@ -38,43 +37,47 @@ People that are using **KeepIt**:
* Automagical image gallery with [lightGallery](https://github.com/sachinchoolur/lightGallery)
* ...

# Getting Started
## Getting Started

Clone this repository to your hugo theme directory.

```bash
cd themes
git clone https://github.com/Fastbyte01/KeepIt.git
cd themes
git clone https://github.com/dillonzq/LoveIt.git
```

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

```bash
theme = "KeepIt"
theme = "LoveIt"
```

For more information read the [official setup guide](https://gohugo.io/documentation/) of Hugo.

# Site Configuration
## Site Configuration

Take a look in the `exampleSite` folder.

This directory contains an example config file and the content for the demo. It serves as an example setup for your documentation.

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

# Content Suggestions
## 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/10/screenshot.png

# Customizing styles for your website
## 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/default.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
## Favicons, Browserconfig, Manifest

It is recommended to put your own favicons

Expand All @@ -85,54 +88,62 @@ It is recommended to put your own favicons
* android-chrome-192x192.png (192x192)
* android-chrome-512x512.png (512x512)

into `/static`. They’re easily created via https://realfavicongenerator.net/.
into `/static`. They’re easily created via [https://realfavicongenerator.net/](https://realfavicongenerator.net/).

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

# Tips
## Tips

#### Set production environment when generating site
### Set production environment when generating site

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

```bash
HUGO_ENV=production hugo --gc --minify
HUGO_ENV=production hugo --gc --minify
```

#### Hugo “extended” Sass/SCSS version required
### Hugo “extended” Sass/SCSS version required

This theme write style with scss, So you must download and install the “extended” Sass/SCSS version

#### How to toggle dark-light mode
### How to toggle dark-light mode

* You can click the sun logo to toggle dark-light mode. In the desktop version the sun logo 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](https://github.com/Fastbyte01/KeepIt/blob/master/assets/js/main.js#L32)

# Home Post model
## Home Post model

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

```toml
[params]
home_mode = "post" # post or other
[params]
home_mode = "post" # post or other
```
# Add logo and cover for SEO

## Add logo and cover for SEO

Add a logo image (127x40) and a cover image (800x600). This images are used for SEO.

# Questions, ideas, bugs, pull requests?
All feedback is welcome! Head over to the [issue tracker](https://github.com/Fastbyte01/KeepIt/issues).
## Questions, ideas, bugs, pull requests

For more configuration info or other tips you can see the [wiki](https://github.com/Fastbyte01/KeepIt/wiki).
All feedback is welcome! Head over to the [issue tracker](https://github.com/dillonzq/LoveIt/issues).

For more configuration info or other tips you can see the [wiki](https://github.com/dillonzq/LoveIt/wiki).

## License

# License
LeaveIt is licensed under the MIT license. Check the LICENSE file for details.
The following resources are included in the theme:

* lazysizes - https://github.com/aFarkas/lazysizes
* lightGallery - https://github.com/sachinchoolur/lightGallery
* code-prettify - https://github.com/google/code-prettify
* [lazysizes](https://github.com/aFarkas/lazysizes)
* [lightGallery](https://github.com/sachinchoolur/lightGallery)
* [code-prettify](https://github.com/google/code-prettify)

## Author

# Author
[Fastbyte01](https://github.com/Fastbyte01)
[Dillon](https://dillonzq.com)

# See Also
## See Also

* [Hermitt](https://github.com/Track3/hermit)
* [Goa](https://github.com/shenoybr/hugo-goa)
2 changes: 1 addition & 1 deletion layouts/partials/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<span class="author" itemprop="copyrightHolder"><a href="{{ .Site.BaseURL }}">{{ .Site.Params.author }}</a> |
</span>
{{ end }}
<span>{{ (printf (T "powered") `<a href="https://gohugo.io/" target="_blank" rel="external nofollow noopener noreffer">Hugo</a>`) | safeHTML }} | {{ T "theme" }}<a href="https://github.com/dillonzq/KeepIt" target="_blank" rel="external nofollow noopener noreffer">KeepIt</a></span>
<span>{{ (printf (T "powered") `<a href="https://gohugo.io/" target="_blank" rel="external nofollow noopener noreffer">Hugo</a>`) | safeHTML }} | {{ T "theme" }}<a href="https://github.com/dillonzq/LoveIt" target="_blank" rel="external nofollow noopener noreffer">LoveIt</a></span>
</div>
</footer>

Expand Down
16 changes: 8 additions & 8 deletions theme.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# theme.toml template for a Hugo theme
# See https://github.com/gohugoio/hugoThemes#themetoml for an example

name = "KeepIt"
name = "LoveIt"
license = "MIT"
licenselink = "https://github.com/Fastbyte01/KeepIt/blob/master/LICENSE"
licenselink = "https://github.com/dillonzq/LoveIt/blob/master/LICENSE"
description = "A minimal and responsive theme for Hugo."
homepage = "https://www.fsb01.com/"
homepage = "https://dillonzq.com/"
tags = [
"blog",
"minimal",
Expand All @@ -27,10 +27,10 @@ features = [
min_version = "0.53"

[author]
name = "Fastbyte01"
homepage = "https://www.fsb01.com/"
name = "Dillon"
homepage = "https://dillonzq.com/"

[original]
name = "LiuZhichao"
homepage = "https://liuzhichao.com/"
repo = "https://github.com/liuzc/LeaveIt/"
name = "Fastbyte01"
homepage = "https://www.fsb01.com/"
repo = "https://github.com/Fastbyte01/KeepIt"

0 comments on commit 96029ea

Please sign in to comment.