A vuepress theme with tons of features✨ / 一个具有强大功能的 vuepress 主题 ✨
Current branch is based on VuePress@v2, and still in W.I.P. For stable releasae in v1, please see v1 branch.
当前分支基于 VuePress@v2,仍处于 W.I.P. 稳定 v1 发行版请参见v1 分支。
V2 will come together with VuePress@v2, with the power of vite@v2 webpack@v5 and vue@v3.
V2 will be a totally rewrite including:
- All the components will be rewrite with composition api in vue3
- All the styles will be mirgate to sass
Also we are going to make sure the rewrite one has a better performance!🚀 (no less than 25% increasement)
Here is a list of changes:
Note: All plugin names are in PascalCase and without
vuepress-plugin-
prefix, you should change tokebab-case
and add the prefix yourself to get the correct plugin name.
We are just making this plugin compatable with V2. This plugin will no longer under maintainment.
AdBlocks are blocking addThis link heavily, and in most cases this plugin won't work.
We will provide a new share plugin in v2.
Renamed from @mr-hope/vuepress-plugin-comment
to vuepress-plugin-comment2
. ⚠
-
Valine is lack of maintainence and can leak your privacy. You should use Waline instead.
Vssue is currently being dropped because vssue has not support v2 yet. We will add it back after it supports v2.
Renamed from @mr-hope/vuepress-plugin-copy-code
to vuepress-plugin-copy-code2
. ⚠
Renamed from @mr-hope/vuepress-plugin-feed
to vuepress-plugin-feed2
. ⚠
-
Option
delay
(default500
) for handling the page swtiching transition. -
We are adding mermaid support, and mermaid support flowchart.
-
Move SlidePage layout from theme to the plugin
- Build a photo preview plugin using lightGallary
Renamed from @mr-hope/vuepress-plugin-pwa
to vuepress-plugin-pwa2
. ⚠
This plugin will still be under maintained, but we are going to build a better plugin using lightGallary.
Renamed from @mr-hope/vuepress-plugin-reading-time
to vuepress-plugin-reading-time2
. ⚠
- A new palette handling config and palette across theme and plugins using sass
Options:
export interface PaletteOptions {
/** identifier for palette */
id: string;
/**
* user config file path, relative to source dir
*
* @default ".vuepress/styles/config.scss"
*/
config?: string;
/**
* default config file path, should be absolute path
*
* This is the file you should use to provide default values with `!default`
*
* @default "vuepress-plugin-sass-palette/styles/default/config.scss"
*/
defaultConfig?: string;
/**
* user palette file path, relative to source dir
*
* @default ".vuepress/styles/palette.scss"
*/
palette?: string;
/**
* default palette file path, should be absolute path
*
* This is the file you should use to provide default values with `!default`
*
* @default "vuepress-plugin-sass-palette/styles/default/palette.scss"
*/
defaultPalette?: string;
/**
* user style file path, relative to source dir
*
* @default ".vuepress/styles/palette.scss"
*/
style?: string;
}
Renamed from @mr-hope/vuepress-plugin-seo
to vuepress-plugin-seo2
. ⚠
- A new share plugin providing page share.
- Build a own blog plugin to support blog with better performance
Renamed from @mr-hope/vuepress-plugin-sitemap
to vuepress-plugin-sitemap2
. ⚠