Icon support

Mr.Hope ... Feature
  • Icon
  • Feature
About 1 min

The entire theme has added FontClass format icon support in mutiple places.

You can use iconfont and fontawesome to add icons to your project.

  • For china users, iconfont is recommended
  • For overseas users, fontawesome is recommended

# Iconfont

Iconfont (opens new window) is a vector icon management and communication platform created by Alimama MUX.

The designer uploads the icon to the Iconfont platform, and the user can customize the download of icons in a variety of formats. Users can also convert the icon into a font.

# How to use

First, you need to create a new project to set and manage your website’s icons:

  1. Log in to Iconfont using GitHub or Weibo.
  2. Find "Resources → My Projects" at the top of the website, and click the "New Project" icon in the upper right corner.
  3. Set a recognizable project name
  4. Fill in FontClass/Symbol prefix with icon- (you can also fill in according to your preference, but you need to set this value to themeConfig.iconPrefix)
  5. Font Family please keep iconfont

New Project

# Import icon

  1. Search freely through iconfont to find the icon you want to use, and click the "Add to Library" button on the icon

    Add to library

  2. After searching for all the icons, click the "Add to Library" icon in the upper right corner, click "Add to Project" below and select the project you created then confirm.

# Edit icon

On the project page, you can edit the icons in the project, including adjustments with position, size, rotate, color, Unicode number and Font Class / Symbol.

Edit icon

# Generate icon files

  1. Please click the "Font Class" button above the project and click Generate.

    Add to library

  2. Import the link in index.styl of .vuepress/styles. E.g:

    @import "//at.alicdn.com/t/font_1446717_4irvtfrarcx.css";
    
    1

Tips

If you add a new icon in the future, please regenerate the new CSS address and overwrite the old CSS address in .vuepress/styles/index.styl.

# Fontawesome

This theme has built-in Fontawesome support.

# Import

Add in index.styl of .vuepress/styles:

@import "~@mr-hope/vuepress-shared/styles/font-awesome";
1

Font-awesome current version is 5.15.1

And set themeConfig.iconPrefix to ''.

# Use

Please follow fontawesome document (opens new window).

# other instructions

  • Icon will have iconfont class name by default
  • The prefix of the icon class is icon- by default, which can be changed in the iconPrefix field in themeConfig