Page information
By including @mr-hope/vuepress-plugin-components
(opens new window), vuepress-theme-hope
can display article information for you.
# Enable
Page information display is enabled globally by default, while supports local config[1]. You can disable it by setting pageInfo: false
in frontmatter of a specific page.
To keep it globally disabled, please set pageInfo
to false
in the plugin options. Then you can set pageInfo
in frontmatter of a specific page to enable it locally.
# Parameters Support page config
pageInfo
accepts an array of strings by default, filling in a group of items. The order of filling is the order in which the items are displayed.
The optional values and corresponding contents of the entry are as follows:
Entry | Corresponding content | page frontmatter value |
---|---|---|
'author' | author | author |
'time' | Writing Date | time |
'category' | Category | category |
'tag' | tags | tags |
'reading-time' | Estimated reading time | N / A (automatically generated) |
'word' | Word count | N / A (automatically generated) |
'visitor' | Visits | visitor (only Valine is available) |
By default it will display "Author, Visit Number, Writing Date, Category, Tags, Expect Reading Time".
# author Support page config
Example:
---
author: Mr.Hope
---
2
3
You can configure author
in the plugin options to set the default author. And you can also configure author
in frontmatter with a new value in the page to override the default author, or set it to false
to cancel the author display.
# Writing time
We recommended to fill it with a standard date format. A standard format is in the form of xxxx-xx-xx
, such as "April 1, 2020" should be written as 2020-04-01
.
Example:
---
time: 2020-01-01
---
2
3
# Category and Tags
See blog section for details
# Reading time
The default statistic method is 300 words per minute. You can override it by setting wordPerminute
in the plugin configuration. This option does not support individual configuration on the page.
# View Count Support page config
When Comment Function is configured as Valine, this function is enabled by default.
Example:
---
visitor: false
---
2
3
Page config support
Support local configurationSupport page config means that the theme allows the configuration of the page to override the global configuration.
↩︎Example
Take path navigation as an example:
This feature is enabled globally by default, that is,
themeConfig.breadcrumb
istrue
by default, and you can setbreadcrumb: false
in the front matter of a specific page to disable it locally.Of course, you can also set the
themeConfig.breadcrumb
option tofalse
to disable it globally, and setbreadcrumb: true
in the front matter of a specific page to enable it locally.