hopeless-cloud/themes/JuiceBar
2023-06-14 21:16:37 +02:00
..
archetypes First draft 2023-06-14 21:16:37 +02:00
assets/scss First draft 2023-06-14 21:16:37 +02:00
exampleSite First draft 2023-06-14 21:16:37 +02:00
images First draft 2023-06-14 21:16:37 +02:00
layouts First draft 2023-06-14 21:16:37 +02:00
static First draft 2023-06-14 21:16:37 +02:00
.gitignore First draft 2023-06-14 21:16:37 +02:00
config.toml First draft 2023-06-14 21:16:37 +02:00
LICENSE First draft 2023-06-14 21:16:37 +02:00
README-zh_CN.md First draft 2023-06-14 21:16:37 +02:00
README.md First draft 2023-06-14 21:16:37 +02:00
theme.toml First draft 2023-06-14 21:16:37 +02:00

JuiceBar

English | 简体中文

JuiceBar is a concise, elegan blog theme powered by Hugo.

This theme drew a lot of inspiration from PapermMod and LoveIt, and credit is due to their excellent work.

Demo → juicebar-demo.add1.dev


Overview

Features

  • Theming: dark/light mode, depending on your system preferences or the users choice
  • An easy way to modify the theme with Hugo tooling
  • Fully responsive
  • Support for social icons
  • Some beautiful CSS animations
  • Easy-to-use and self-expanding table of contents
  • Automatically highlighting code
  • Custom script shortcode
  • giscus comment system supported by giscus
  • Simple Article Encryption Feature (Note: Highly insecure, use with caution)

How to start

You can install the theme either as a clone or submodule.

I recommend the latter. From the root of your Hugo site, type the following:

$ git submodule add https://github.com/hotjuicew/hugo-JuiceBar.git themes/JuiceBar

Now you can get updates to hugo-JuiceBar in the future by updating the submodule:

$ git submodule update --remote themes/JuiceBar

How to configure

The theme doesn't require any advanced configuration. Just copy the following config file.

config.toml

baseURL = 'http://example.org/' 
languageCode = 'en-us'
theme = "JuiceBar"
title = "your_blog_title"

[params]
author = "your_name"
description = "My site description"
authorImage = "/images/profile.jpg"
paginate = 5 
Title = "your_blog_title"
content = "I'm JuiceBar, nice to meet you(ˊ˘ˋ*)♡"
imageUrl = "/images/avatar.jpg"

# To add a new social icon 
# More social icons can be found in JuiceBar\layouts\partials\svg.html.
[[params.social]]
name = "Github"
url = "https://github.com/hotjuicew"
[[params.social]]
name = "telegram"
url = "https://t.me/Hotjuice"
[[params.social]]
name = "twitter"
url = "https://twitter.com/hotjuicee"
[[params.social]]
name = "email"
url = "mailto:hotjuicew@outlook.com"
[[params.social]]
name = "instagram"
url = "your_url"
[[params.social]]
name = "mastodon"
url = "your_url"
[[params.social]]
name = "reddit"
url = "your_url"
[[params.social]]
name = "stackoverflow"
url = "your_url"

[taxonomies]
category = "categories"
tag = "tags"

# To add a new navigation link
[[menu.main]]
name = "About"
url = "/about"
[[menu.main]]
name = "Blog"
url = "/post"
[[menu.main]]
name = "Categories"
url = "/categories"

# If using the giscus commenting system
#[params.giscus]
#repo = "ENTER REPO HERE"
#repoID = "ENTER REPO ID HERE"
#category = "ENTER CATEGORY NAME HERE"
#categoryID = "ENTER CATEGORY ID HERE"
#mapping = "og:title"
#reactionsEnabled = "1"
#emitMetadata = "0"
#inputPosition = "bottom"
#lang = "en"
#loading = "lazy"

# Used for outputting the documentation (required).
[outputs]
home = ["HTML", "RSS", "JSON"]

Note: There are more options to configure. Take a look into the config.toml in exampleSite.

After installation, take a look at the exampleSite folder inside themes/hugo-JuiceBar.

To get started, copy the config.toml file inside exampleSite to the root of your Hugo site:

$ cp themes/hugo-JuiceBar/exampleSite/config.toml .

Now edit this file and add your own information. Note that some fields can be omitted.

I recommend you use the theme's archetypes so now delete your site's archetypes/default.md.

Finally, just run $ hugo new content/about.md to create your 'About' page, and $ hugo new content/post/title.md to create your first blog post.

How to Use Article Protection

(Please note that password protection is intended to prevent unauthorized access only and may not be effective against skilled individuals or deliberate attacks. Use it accordingly.) Simply add to the meta information of the post

protected: true
password: "xxxxxx"