# Theme Configuration

# Configuration File

Convention > Configuration

WARNING

Please define the configuration you need in source/_data/yun.yml, the rest will automatically use the default configuration.

Unless otherwise specified, they are configured by default in the yun.yml file.

It is best not to modify any of the theme's files unless you have certain development capabilities, or else the theme can not be upgraded afterward.

# Language

The default language is Chinese zh-CN.

The language of the site needs to be set in _config.yml under the Hexo directory.

language: en

# Customized Language

Create a new source/_data/language.yml in the Hexo working directory. (If the source/_data directory does not exist, please create a new one.)

With the convention greater than the configuration, you only need to customize the paragraph or words you want to override in language.yml , and the rest will be automatically merged with the theme's default configuration. (This is also more convenient for future upgrades)

Here follows a configuration example,

en: # the language need to be overridden
  menu:
    home: My Index

ja: # the language need to be overridden
  menu:
    home: マイインデックス

zh-CN: # the language need to be overridden
  menu:
    home: 我的主页

If english is the only used language, all items can be erased other than en.

# Theme Color

The main color of the custom theme.

  • bg: background color (choose a color closer to the main color of your background image in order to make it more coordinated)

color-dust (opens new window) I wrote a small tool that can analyze the color in pictures.

colors:
  primary: "#6200ee"
  # bg: "# F5F5F5"
  selection_bg: "#8e71c1" # background color when selecting text
  # Starting and ending colors of the tags
  # tag_start_color:
  # tag_end_color:

# Tags

You can specify the color for your label, the default color is #333.

tags:
  Vue: "#4fc08d"
  Hexo: "#0E834D"
  CSS: "#5298d1"
  Node.js: "#026E00"
  Git: "#F14E32"
  React: "#61dafb"
  Python: "#3776ab"
  PHP: "#8892BF"
  VS Code: "#0066B8"
  JavaScript: "#F4DF4F"
  TypeScript: "#317AC6"
  Laravel: "#F4645F"

# Categories

You can specify the color for your category, the default color is #333.

categories:
  Notes: dimgray

# Head Resources

If you have resources that you want to load, please add them to the head.

Follow the example below to customize the css and js resources you want to add.

JavaScript resource type description:

  • base: must be loaded and executed in advance.
  • async: Asynchronous loading, executed immediately after loading.
  • defer: load the resource asynchronously, but execute it last.
head:
  css:
    example: //example.min.css
  js:
    base:
    async:
    defer:

TIP

If you want to custom css,please set yun.yml:

head:
  css:
    custom: /css/custom.css

file is source/css/custom.css (Just new it yourself!)

Then write you custom css.

.char {
  background-color: transparent;
}

# favicon

Set the website icon (make sure your favicon.ico file is placed under the source folder), set as follows:

favicon: /favicon.ico

Yun Logo can use the corresponding opposite colors according to the light and dark theme of the browser.

For example, the bright browser LOGO has a black stroke, and the dark browser LOGO has a white stroke.

Your icon must be an svg file, and add a corresponding style to it.

You can refer to my LOGO SVG code. yun.svg (opens new window)

For Example:

<svg id="yun-logo">
  <style>
    #yun-logo {
      stroke: black;
    }

    @media (prefers-color-scheme: dark) {
      #yun-logo {
        stroke: white;
      }
    }
  </style>
</svg>

Dark Mode Favicons (opens new window)

# CDN

Content Delivery Network unifies the loading of network resources; it is conducive to improving the speed of web page loading.

jsDelivr – Open Source CDN (opens new window) is a free and open-source CDN, with good domestic speed performance, and a unified CDN source which is also conducive to loading speed. Therefore, this theme's CDN defaults to jsDelivr and uses dns-prefetch to pre-parse jsDelivr.

You can also obtain the CDN you want according to the naming rules, and introduce it in the head:

cdn is the CDN resource currently introduced by the theme by default, and its structure is similar to head.

cdn:
  pre: ""
  css:
  js:
    base:
    async:
      # Icon resources introduced by default, use iconfont
      iconfont: //at.alicdn.com/t/font_1140697_stqaphw3j4.js
    defer:
  • pre: empty by default, your loading resource prefix. For example, if you want to use jsdelivr to accelerate the static resources of the whole station, you can set it in yun.yml like this.

Replace https://cdn.jsdelivr.net/gh/ with your GitHub username and repository name (you can also add the current branch, such as @master). @latest is to use the latest version (but it will still be cached, and it will take 12 hours to update, if you need to force a refresh, please refer to Purge Cache (opens new window) In addition, please make sure that your avatar image link uses /images/xxx.jpg instead of https://xxx/xxx.jpg.

cdn:
  pre: https://cdn.jsdelivr.net/gh/YunYouJun/[email protected]

TIP

If you customize the resources used by the theme and want to preview and debug locally more conveniently,

you can add " dev ":" export NODE_ENV = dev && hexo s " in the scripts field of package.json in the Hexo working directory.

{
  "scripts": {
    "dev": "export NODE_ENV= ev &&hexo s"
  }
}

And start it through npm run dev; it is now in development mode.cdn.pre is not used by default.

# Overwrite Icon Font

cdn:
  js:
    async:
      iconfont: your iconfont custom resource

# Preloading

Use preload, prefetch, preconnect, dns-prefetch to optimize the speed of webpage recording.

  • preload: resources that will be used after this page
  • prefetch: resources that may be used after jump to the page
  • dns-prefetch: resolve the DNS address of the domain name that will be used
  • preconnect: establish a link with the specified domain name in advance; it has more TCP connections thandns-prefetch

preload and prefetch are only used to load local resources (and generally use by default). Do not use resources with a protocol header (http://).

CDN can be added at head.

<link> : External resource link element-MDN (opens new window)

preload:
  style:
    - /css/hexo-theme-yun.css
  script:
    - /js/utils.js
    - /js/hexo-theme-yun.js

prefetch:
  script:
    - /js/sidebar.js

dns_prefetch:
  - https://cos.yunyoujun.cn

# do more (TCP handshake ...) than dns-fetch
preconnect:
  - https://cdn.jsdelivr.net

# Icon Library

This theme uses some of Remix Icon's icons by default and loads through cdn generated by iconfont.

The default icon list refer to default icons

If you want to use other icons, the following icons are recommended.

  • Method 1: Most recommended, all use custom iconfont icon set. (Fast speed, but need to be configured by yourself)
  • Method 2: Freely import the css style file of the font icon in [head](#head-head resource), and directly input the corresponding class name. (Often all icon resources are introduced. Although it is convenient to introduce them at once, many icons are not practical.)

TIP

You can go to iconfont (opens new window) to customize a set of icons and cover the icon resources introduced by [CDN] (# CDN). If you just want to add a few extra icons, you'd better introduce it at [head](# head-header resource) instead of directly overwriting it.

Here are some ways to use basic icons.

This theme is adapted to the use of the following icons.

# iconfont (opens new window)

Under Alibaba, you can customize your own icon set. Domestic speed is decent in China. (recommend)

Instructions (opens new window)

Multi-color icons need to be quoted in the symbol of the article.

Then set as follow in yun.yml.

head:
  js:
    async:
      # Here is the icon link you got from iconfont.
      iconfont: //at.alicdn.com/t/font_1623879_a03x3er7qur.js

# Remix Icon (opens new window)

Simple, elegant and open source.

# Ionicons (opens new window)

There is no trademark icon, you can use Web Component and load it on demand.

# Loading Method 1: Web Component

It can automatically switch the suitable style Material/ iOS according to the Android/iOS platform.

This theme has adapted the way the ion-icon tag is introduced, just configure it as follows.

head:
  js:
    async: https://cdn.jsdelivr.net/npm/ionicons/dist/ionicons.js
icon: ion-icon heart

# Loading Method 2: CSS Introduction

head:
  css:
    ionicons: https://cdn.jsdelivr.net/npm/ionicons/dist/css/ionicons.min.css
icon: icon ion-md-heart

# Material Design icons (opens new window)

Uniform style, no trademark icon. Produced by Google, due to domestic policies, loading may not be stable if using in China.

The theme has also been adapted.

TIP

Why do we need to adapt?

Original way of use

face is the internal content of <i></i>, not class.

<i class="material-icons">face</i>

引入对应 CDN 资源:

head:
  css:
    material: https://fonts.googleapis.com/icon?family=Material+Icons
icon: material-icons face

# Other Icons

Similar to the use of the above icons fill in the corresponding icon class in the icon-related configuration.

Such as Font-Awesome (opens new window)

GitHub: Font-Awesome (opens new window)

Introduce CSS:

head:
  css:
    fontawesome: https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free/css/all.min.css

Write class name:

icon: fas fa-home

In fact, it is not recommended to introduce all font-awesome, because it is really big.

# Social Icons

The following social icons are provided by default. You can obtain more icons by introducing custom icon resources in [head](#head-head resource) For better display, my default link will be displayed.

  • name: link name
  • link: link
  • icon: Icon Class
  • color: Icon color (If the icon you introduced supports SVG custom colors in advance) The current default color adopts the official icon brand color.
social:
  - name: RSS
    # set rss in your root config
    # https://github.com/hexojs/hexo-generator-feed
    link: atom.xml # config.feed.path
    icon: icon-rss-line
    color: orange
  - name: QQ
    # https://isux.tencent.com/wp-content/uploads/2016/05/20160512101222609.pdf
    link: https://wpa.qq.com/msgrd?v=3&uin=910426929&site=qq&menu=yes
    icon: icon-qq-line
    color: "# 12B7F5"
  - name: GitHub
    link: https://github.com/YunYouJun
    icon: icon-github-line
    color: "# 181717"
  - name: E-Mail
    link: mailto: [email protected]
    icon: icon-mail-line
    color: "# 8E71C1"
  - name: Weibo
    link: https://weibo.com/jizhideyunyoujun
    icon: icon-weibo-line
    color: "# E6162D"
  - name: Douban
    link: https://www.douban.com/people/yunyoujun/
    icon: icon-douban-line
    color: "# 007722"
  - name: NetEase Cloud Music
    link: https://music.163.com/#/user/home?id=247102977
    icon: icon-netease-cloud-music-line
    color: "# C10D0C"
  - name: Zhihu
    link: https://www.zhihu.com/people/yunyoujun/
    icon: icon-zhihu-line
    color: "# 0084FF"
  - name: Bilibili Animation
    link: https://space.bilibili.com/1579790
    icon: icon-bilibili-line
    color: "# FF8EB3"
  - name: POPI
    link: https://www.popiask.cn/elpsycn
    icon: icon-questionnaire-line
    color: "# 525252"
  - name: WeChat official account
    link: https://cdn.jsdelivr.net/gh/YunYouJun/cdn/img/about/white-qrcode-and-search.jpg
    icon: icon-wechat-2-line
    color: "# 1AAD19"
    - name: Twitter
    link: https://twitter.com/YunYouJun
    icon: icon-twitter-line
    color: "#1da1f2"
  - name: Telegram
    link: https://t.me/YunYouJun
    icon: icon-telegram-line
    color: "#0088CC"
  - name: Telegram Channel
    link: https://t.me/elpsycn
    icon: icon-telegram-fill
    color: "#0088CC"

You only need to set social in yun.yml to overwrite it (at this time you can only display your mailbox icon and no other icons):

social:
  - name: E-Mail
    link: mailto: your email
    icon: icon-mail-line
    color: "#8E71C1"

If you don't want to put any links, just set the following in yun.yml:

social:

# Home

# Slogan Animation

The verticallly staggered text effect on the homepage is enabled by default.

You can visit https://yunyoujun.cn (opens new window) to see the effect. (Each refresh will display random font size)

This is the earliest function implemented during the development of this theme. During the period, it was refactored several times due to compatibility issues of browsers such as Safari, and the loading speed was also improved. It was a function that went through three dynasties, lol.

  • enable: whether to enable -title: set text content
  • title: Text content
  • border: display the left and right border of char
  • cloud: Display float cloud
    • enable: enable it
    • color: custom cloud color
  • go_down: go down arrow button (click it to go down)
banner:
  enable: true
  title: 云游君的小站
  src: /js/ui/banner.js
  border: true
  cloud:
    enable: true
    color: "white"
  go_down:
    enable: true
    icon: icon-arrow-down-s-line

You can customize the character segmentation in the form of an array, for example:

banner:
  title:
    - Yun
    - You
    - Jun
    - Blog

# Announcement

You can configure the announcement as follows. It will be displayed at the top of all article cards, below the tagline.

notice:
  enable: true
  content: Thanks for playing my game.

# UI

# Light and Dark Mode

  • light: always light mode without dark style assets
  • dark: always dark mode
  • auto: switch mode by system mode, display toggle button in sidebar
  • time: switch light and dark mode by time, 07:00-19:00 is light mode, and the remaining time is dark mode

Black icon will be white in dark mode.

You can set isolate background for dark mode, please see corresponding config.

# light | dark | auto | time
mode: auto

# Font

You can set your font family and font-weight.

TIP

If you use non-system-built fonts, you also need to go to head to import them.

For example, the “Noto Serif SC” font with a weight of 900 is introduced.

In order to ensure that this theme is light enough, no fonts are introduced by default, and the default fonts that come with the system are used. You can decide whether to introduce it.

head:
  css:
    fonts: https://fonts.googleapis.com/css2?family=Noto+Serif+SC:[email protected]&display=swap

The fonts of this theme are mainly divided into the following three categories.

You can only cover the font family you want to cover.

  • Serif: The bolder form is emphasized, and is usually used in homepage banners, Say, site and article titles (and the names of works on pages such as links and girls).
  • Sans Serif: Usually normal text content. (If your font is bold, it may be that you installed the PingFang SC font on the Windows system, but did not install the corresponding font weight.)
  • monospace: The characters all have the same width and are usually used where the same width is required for alignment (such as dates, serial numbers).

Set font.cdn.enable to false to use all system default fonts to achieve the best access speed. (When enabled by default, use media="none" onload="this.media='all'" to achieve css style asynchronous loading.)

font:
  cdn:
    enable: true
    lib:
      - https://fonts.googleapis.com/css2?family=Noto+Serif+SC:[email protected]&display=swap
  serif:
    family: "'Songti SC', 'Noto Serif SC', STZhongsong, STKaiti, KaiTi, Roboto, serif"
    weight: 900
  sans_serif:
    family: "'PingFang SC', 'Microsoft YaHei', Roboto, Arial, sans-serif"
    weight: 400
  monospace:
    family: "'Source Code Pro', 'Courier New', Courier, Consolas, Monaco, monospace"

# Background

  • opacity: background transparency

TIP

Note that the background blur is now disabled by default. It is also recommended that users use image processing tools to blur images for the background.

You can also use some online image blur tools directly. For example, Gaussian Blur (opens new window) (This is only the first one I found on Google, you can find your favorite tool to process it.)

This also eliminates the white borders produced during the application of blur filter to color pictures. At the same time, it can also reduce the background of the image and improve the loading and rendering speed.

  • dark: the image url for dark mode
bg_image:
  enable: true
  url: https://cdn.jsdelivr.net/gh/YunYouJun/cdn/img/bg/stars-timing-0-blur-30px.jpg
  # dark:
  # blur: 30px # Set the blurry degree of background
  opacity: 0.8

If you want to use a custom image background, just put it in the source/images folder and use /images/xxx.jpg to import it.

Note: If you use a subdirectory to place your blog, such as xxx.github.io/blog/, your picture link needs to be set to /blog/xxx, or you can directly use the image hosting.

# Search Background

  • modal If you enable modal, the search background will be the blurred underlying content, and the background image will no longer be used.
  • placeholder: search box prompt text (if not set, the corresponding text will be automatically selected according to Hexo language configuration)
  • dark_bg_image: background for dark mode
search:
  modal: true
  bg_image: https://cdn.jsdelivr.net/gh/YunYouJun/cdn/img/bg/stars-timing-2.jpg
  dark_bg_image: xxx
  # placeholder:

For more search settings, please refer to Search-Third Party Support

# Random Trianglify Background

trianglify - GitHub (opens new window)

Because the background is stretched, larger width and height will get higher definition. (Please make a trade-off with performance)

trianglify:
  enable: false
  cellSize: 75
  width: 800
  height: 600
  palette: '["YlGnBu", "GnBu", "Purples", "Blues"]'
  opacity: 0.5

# Fireworks

Click on the fireworks effect on the page

  • enable: whether to enable, enable by default
  • colors: the included colors, the default is several levels of blue colors (please follow the RGB values ​​below)
fireworks:
  enable: true
  colors:
    - "102, 167, 221"
    - "62, 131, 225"
    - "33, 78, 194"

Reference from: Anime.js Fireworks canvas demo (opens new window)

# ScrollReveal

The scrolling effect of the card on the home page can be seen in Official Website (opens new window), which is enabled by default.

  • targets: set targets for scrolling effect
scrollreveal:
  enable: true
  targets:
    - .post-card
    - .post-content img

# Cursor Cursor

Replace the mouse cursor, which is off by default. By default, Material Design Cursors (opens new window) is used by default.

You can also use your favorite icon instead.

  • default: Icon in the default state.
  • pointer: pointer (that is, in the link state) icon.
cursor:
  enable: false
  default: https://cdn.jsdelivr.net/gh/YunYouJun/cdn/css/md-cursors/pointer.cur
  pointer: https://cdn.jsdelivr.net/gh/YunYouJun/cdn/css/md-cursors/link.cur
  text: https://cdn.jsdelivr.net/gh/YunYouJun/cdn/css/md-cursors/text.cur
  • tagcloud: display it in sidebar
    • amount: the amount of tags
sidebar:
  bg_image: https://cdn.jsdelivr.net/gh/YunYouJun/cdn/img/bg/stars-timing-1.jpg
  bg_position: bottom 3rem center
  tagcloud:
    enable: false
    amount: 20

Notice: If you use a sub-directory to place your blog, such as xxx.github.io/blog/, your image link needs to be set to /blog/xxx, or you can directly use the image bed.

bottom 3rem center means it is centered and 3rem from the bottom.

You can refer to background-position (opens new window) to set the position of the background image.

# Avatar

  • enable: whether to show avatar
  • url: avatar image link
  • rounded: whether to be circled
  • opacity: transparency
  • mickey_mouse: Closed by default. When ON, the avatar of the sidebar of the article page will move upwards (Disney copyright alert)
  • status
    • enable: whether to display status
    • emoji: emoji
    • message: message for emoji
avatar:
  enable: true
  url: /images/avatar.jpg
  rounded: true
  opacity: 1
  mickey_mouse: false
  status:
    enable: true
    emoji: 😭
    message: Don't want to go to school.

The effect after mickey_mouse is enabled:

mickey-mouse

Set navigation corresponding icons and links

They are:

  • Home
  • List
    • Archives
    • Tags
    • Categories
  • Custom (You can set any icon and link. When you do not set a custom icon link, it will automatically become a document navigation button to maintain the overall symmetry)

By the way, read the documentation first when encountering an issue

list

  • type: archives/categories/tags, it will automatically match this type of title and display the corresponding quantity. Leave blank for other normal links.
  • title: override default title
  • icon: custom your icon
  • path: custom path or url
  • count: the amount of type, you can set custom text
menu:
  home:
    path: /
    icon: icon-home-4-line
  list:
    - type: archives
      path: /archives/
      icon: icon-archive-line
    - type: categories
      path: /categories/
      icon: icon-folder-2-line
    - type: tags
      path: /tags/
      icon: icon-price-tag-3-line
    # - path: https://www.yunyoujun.cn
    #   icon: icon-cloud-line
    #   count: guess it
  custom:
    title: Document
    path: https://yun.yunyoujun.cn
    icon: icon-settings-line

At the bottom of the sidebar, add some eye-catching icon links.

The icon is larger than Social Link. You can place your page navigation, friend links, etc.

e.g.:

Theme page

pages:
  - name: my friends
    url: / links /
    icon: icon-genderless-line
    color: dodgerblue

If you don't want to put any links, just set the following in yun.yml:

pages:

# Article

# Home Card

-opacity: customize the transparency of the homepage card, the default is set to 0.8

post_card:
  opacity: 0.8

# Type

By setting the type attribute for an article, you can turn it into another type of card and jump to the link set by url.

e.g.:

---
title: xxx
type: bilibili
url: https://www.bilibili.com/video/av8153395/
---

The bilibili icon will appear in front of the article title. Clicking on the title will jump to the corresponding link.

Currently, the following types are supported by default (Bilibili, Douban, GitHub, NetEase Cloud Music, WeChat Official Account, Weibo, Yuque, Twitter, Zhihu, and Outer Links):

types:
  link:
    color: blue
    icon: icon-external-link-line
  bilibili:
    color: "#FF8EB3"
    icon: icon-bilibili-line
  douban:
    color: "#007722"
    icon: icon-douban-line
  github:
    color: black
    icon: icon-github-line
  netease-cloud-music:
    color: "#C10D0C"
    icon: icon-netease-cloud-music-line
  notion:
    color: black
    icon: icon-notion
  twitter:
    color: "#1da1f2"
    icon: icon-twitter-line
  wechat:
    color: "#1AAD19"
    icon: icon-wechat-2-line
  weibo:
    color: "#E6162D"
    icon: icon-weibo-line
  yuque:
    color: "#25b864"
    icon: icon-yuque
  zhihu:
    color: "#0084FF"
    icon: icon-zhihu-line

You can also set your icon and color for different links in yun.yml.

type:
  google:
    color: xxx
    icon: xxx

When the type you specified does not exist in the default nor is customized, the blue extra link icon will be used by default.

If you want to display information on your external link card, you can write it before <!-- more -->, it will be displayed as a summary.

e.g.:

---
title: hexo-theme-yun
type: github
url: https://github.com/YunYouJun/hexo-theme-yun
---

Hexo theme Yun

<!-- more -->

# Hide

You can add a hide attribute at the head of the article to temporarily hide an article.

  • hide:
    • index: only hide in index, display in archives
    • true: not display in index and archives, but rendered. You can visit the link to view.

What? Do you want to not render or display at all? Then why don't you put it in the _drafts folder, or simply not submit this article.

---
title: xxx
hide: true
# hide: index
sitemap: false
indexing: false
---

TIP

If you use sitemap, it will display in sitemap.xml. You need set sitemap: false in front matter to exclude it.

excluding-posts | hexo-generator-sitemap (opens new window)

If you use local-search, it will show in search.xml. You need set indexing: false in front matter to exclude it.

exclude-indexing | hexo-generator-search (opens new window)

# Information

  • item_text: whether to display text (for example: posted on, updated on. If disabled, it will only display icon and time)
  • created_at: whether to show the creation time
  • updated_at: whether to show updated time
  • categories: whether to display categories
  • tags: whether to display tags
post_meta:
  item_text: false
  created_at: true
  updated_at: true
  categories: true
  tags: true

# Table of Contents

As long as you follow Markdown syntax (opens new window), the directory will be automatically generated!

TIP

An HTML page with good SEO has and should have only one h1 as the first level heading. This theme uses the title you set as the first-level title by default. In the content of the following article, you should only start using the secondary heading.

---
title: Level 1 Heading
---

## Level 2 Heading

No one will disable this feature, lol

  • list_number:Displays list number
  • max_depth: Maximum heading depth of generated toc
  • min_depth: Minimum heading depth of generated toc
  • placeholder: Display Text when toc is empty.
  • collapse: Whether to collapse the directory (folded by default, that is, the secondary directory is hidden, and only expanded when it is rolled to the relevant position)
toc:
  list_number: true
  max_depth: 6
  min_depth: 1
  placeholder: Sorry, it is empty.
  collapse: false

Helpers | Hexo (opens new window)

If enabled, an edit icon will be displayed next to the article page title. Click to jump to the editing page.

  • url: the address of the article (you can refer to the default link when setting your warehouse jump link)

If I use GitHub as the hosting warehouse for the blog, the warehouse name is yunyoujun.github.io, under the hexo branch, in the source folder, where my link will be https://github.com/YunYouJun/yunyoujun.github.io/tree/hexo/source/ (opens new window).

post_edit:
  enable: true
  url: https://github.com/YunYouJun/yunyoujun.github.io/tree/hexo/source/

# Code Highlighting

Set code highlight

Due to performance and positioning issues, and Hexo 5.0 (opens new window) has native support for prism, this topic is more recommended to use prismjs (opens new window) instead of highlight.js.

Please upgrade hexo to 5.0.0. npm install [email protected]

PrismJS is a lightweight code highlighting library. Compared with highlight.js, prismjs can be executed in the Node.js environment (that is, code highlighting can be performed when Hexo generates a page).

We can quickly switch themes through the CDN. This theme also supports setting different code highlight themes for light and dark modes.

Languages ​​currently supported by Prism: https://prismjs.com/#supported-languages (opens new window)

Configure in _config.yml in the working directory of Hexo (must be upgraded to version 5.0 or higher):

# disable highlight
highlight:
  enable: false
# enable prism
prismjs:
  enable: true
  preprocess: true
  line_number: false
  tab_replace: ""

In yun.yml:

  • copy_btn: enable copy button in codeblock
  • prismjs
    • light: code highlight style for light
    • dark: code highlight style for dark

(You can set the corresponding suitable highlight styles for the light and dark modes.)

codeblock:
  copy_btn: true
  prismjs:
    light: default
    dark: tomorrow

It is recommended to close the line number, here (opens new window) is the where the author wrote why highlight does not support line numbers. After hexo-prism-plugin enables the line number, there will be some inconsistencies in the theme style. It doesn't matter if the line number exists. When it is removed, some space can be saved. For example, some codes that originally required scroll bars can be completely displayed after being removed.

Set the shared copyright of your article

CC BY-NC-SA 4.0 (opens new window) is used by default.

About Licenses

  • license: set certificate (by | by-nc | by-nc-nd | by-nc-sa | by-nd | by-sa | zero)
  • language: set language (deed.zh | deed.fr | deed.de)
  • post: displayed at the end of each post
  • clipboard: Append copyright information to the clipboard
creative_commons:
  license: by-nc-sa
  post: true
  language: deed.zh
  clipboard: false

Please set your url in _config.yml in the Hexo working directory.

Configuration | Hexo (opens new window)

# URL
## If your site is put in a subdirectory, set url as 'https://yoursite.com/child' and root as '/child/'
url: https://www.yunyoujun.cn

# Image Lazy Loading

Enable by default, it will add loading ="lazy" attribute to the Markdown image img.

loading (opens new window) There are still many browsers that do not support this feature Can I use loading?

lazyload:
  enable: true

# Reward

After enabled, a donating button will be displayed at the end of each article post. (The page is not displayed by default, you need to set reward: true to force it to open.)

  • enable: enable rewards
  • icon: reward icon
  • comment: show what you want to say under the reward button
  • url: your reward link (when you enable the reward link, it will automatically jump to your external link instead of expanding the QR code)
  • methods: Array, the methods of reward

# QR Code for Reward

QQ, WeChat, and Alipay reward icons are supported by default, and color is a custom icon color.

  • name: donating method
  • path: image path
  • color: icon color
  • icon: icon name

You can override it in yun.yml.

reward:
  enable: true
  icon: icon-hand-coin-line
  comment: I'm so cute. Please give me money.
  # url: https://github.com/YunYouJun/yunyoujun.github.io/issues/96
  methods:
    - name: 支付宝
      path: https://cdn.jsdelivr.net/gh/YunYouJun/cdn/img/donate/alipay-qrcode.jpg
      color: "#00A3EE"
      icon: icon-alipay-line
    - name: QQ 支付
      path: https://cdn.jsdelivr.net/gh/YunYouJun/cdn/img/donate/qqpay-qrcode.png
      color: "#12B7F5"
      icon: icon-qq-line
    - name: 微信支付
      path: https://cdn.jsdelivr.net/gh/YunYouJun/cdn/img/donate/wechatpay-qrcode.jpg
      color: "#2DC100"
      icon: icon-wechat-pay-line

You can also set whether to enable rewards at the top of an article.

reward: true
# reward: false

TIP

The following configurations are written under the footer field. (Only a option called footer) Such as:

footer:
  since: 1997
  icon:
    name: icon-cloud-line
    animated: true
    color: "#0078E7"

# Starting Year

footer:
  since: 2016

# Icon

The icon between the year and the name.

  • name: icon name (i.e. class)
  • animated: whether to enable animation
  • color: icon color
footer:
  icon:
    name: icon-cloud-line
    animated: true
    color: "#0078E7"

# Driver

Show the names and versions of the currently used blog framework, Hexo, and the theme Yun with pride.

For example: Driven by Hexo v4.2.0 | Theme-Yun v0.0.2.

Let more people know Hexo and the theme Yun, which is conducive to the further development of the open-source community.

  • enable: Enable
  • version: Display version
footer:
powered:
  enable: true

# Run Time

Disabled by default.

This blog has been running 442 days, 19 hours, 28 minutes and 40 seconds (● '◡' ●)

footer:
live_time:
  enable: false
  prefix: This blog has been run cutely
  suffix: (● '◡' ●)
  start_time: "2019-04-12T00: 00: 00"

Remember to add 0, such as 2019-04-01 instead of 2019-4-1.

# Custom Text

custom_text is a custom footer and can contain HTML. For example, sometimes it can use other service providers to host pages.

footer:
custom_text: Hosted by <a href="https://pages.coding.me" rel="noopener" target="_blank"> Coding Pages </a>

# Say

Randomly display a sentence on the homepage of the website ~~eighth-grade syndrome. (By default, hitokoto (opens new window) is used as the API)

  • enable: whether to enable hitokoto
  • api: Remote JSON API
  • src: the called js file, it is best not to modify it (you can also write it yourself according to its structure to load the desired JSON format.)
  • hitokoto.enable: Whether to enable hitokoto (opens new window), when you enable hitokoto, it will override say.api by default
  • hitokoto.api: You can refer to Statement Interface | hitokoto (opens new window) to use the koto API according to your thoughts
say:
  enable: true
  api: https://cdn.jsdelivr.net/gh/ElpsyCN/[email protected]-pages/sentences.json
  # https://developer.hitokoto.cn/sentence/
  hitokoto:
    enable: true
    api: https://v1.hitokoto.cn

When you close hitokoto, the data at say.api will be used by default.

say.elpsy.cn (opens new window) is where I have stored my eighthgrade syndrome hitokoto collections. = =, automatically export JSON for pulling.

# Customize

You can also use custom sentences.

Create a new data/sentences.json under the source folder in the root directory. (Note that data is not _data, or you can also create another folder.)

The format is as follows:

[
  {
    "content": "Hello, World!",
    "author": "Brian Kernighan",
    "from": "The C Programming Language"
  },
  {
    "content": "The so-called daily life we ​​spend day by day may actually be a continuous miracle.",
    "from": "Daily"
  },
  {
    "content": "Yeah, what I love is neither the stars nor the galaxy.",
    "author": "YunYouJun",
    "from": "yunyoujun.cn"
  },
  {
    "content": "Vague thunder, hazy sky, but hope the wind and rain will keep you here",
    "from": "Wan Ye Ji · 雷神短歌"
  }
]

Then set say.api to /data/sentences.json, and close it.

i.e.:

say:
  enable: true
  api: /data/sentences.json
  src: /js/say.js
  hitokoto:
    enable: false

# Special

# Mourn

On the designated day of the year, the gray mourning mode is enabled.

  • enable: Disabled by default.

On April 4, the nation mourned. In order to express the deep condolences of the people of all ethnic groups in the country in the fight against the Coronavirus Pandemic, at the expense of martyrs and deceased compatriots, the State Council issued an announcement and decided to hold a national mourning event on April 4, 2020.

mourn:
  enable: true
  days: -"4-4"

# Custom Style

Compared with the introduction of head, you can write a stylus file here, use the existing variables of the theme, and compile it into hexo-theme-yun.css.

Create a new source/_data/style folder, and then create a new xxx.styl to start writing your custom style.

For example, import all the .styl files under your source/_data/style in the following way.

custom:
  style: source/_data/style/*

# More Configuration

You can directly view the files and relative comments inthemes/yun/_config.yml (opens new window).

Or refer to the custom configuration of my blog source/_data/yun.yml (opens new window).

Last Updated: 11/15/2020, 1:20:09 PM