vuepress
https://juejin.cn/post/6844903935027707918
https://wangtunan.github.io/blog/vuepress/#%E9%A6%96%E9%A1%B5
# Vuepress
# 中英文
目录结构设置如下：
docs
├─ README.md
├─ foo.md
├─ nested
│ └─ README.md
└─ zh
├─ README.md
├─ foo.md
└─ nested
└─ README.md
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
在./vuepress/config.js中配置
module.exports = {
locales: {
'/': {
lang: 'en-US', // this will be set as the lang attribute on <html>
title: 'VuePress',
description: 'Vue-powered Static Site Generator'
},
'/zh/': {
lang: 'zh-CN',
title: 'VuePress',
description: 'Vue 驱动的静态网站生成器'
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# 多版本
https://v1.docusaurus.io/docs/en/versioning
# Note
vuepress自带markdown拓展，是由插件vuepress-plugin-container实现的，因此可以直接在markdown文档中使用
TIP
This is a tip
WARNING
this is a warning
DANGER
This is a dangerous warning
::: detail
This is a detail block which does not work in IE / Edge
# 搜索
插件vuepress-plugin-fulltext-search
安装
npm i vuepress-plugin-fulltext-search -D
1
修改配置文件引入插件
module.exports = {
// ...
plugins: ['fulltext-search']
}
1
2
3
4
2
3
4
可以自定义搜索参数
在./vuepress/public/js目录下，新建pgmanor-self.js
// 定义最大搜索结果数据
SEARCH_MAX_SUGGESTION = 10;
// 设置搜索路径
SEARCH_PATHS = [];
// 快捷键
SEARCH_HOTKEYS = ['s','i'];
1
2
3
4
5
6
2
3
4
5
6
在config.js中head配置参数
//
module.exports = {
head: [
[
"script",
{
"language":"javascript",
"type":"text/javascript",
"src":"/js/pgmanor-self.js"
}
]
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
2
3
4
5
6
7
8
9
10
11
12
13
flexsearch
安装依赖
npm i -D vuepress-plugin-flexsearch
1
修改配置
module.exports = {
plugins: [
['flexsearch', {
maxSuggestions: 10,
searchPaths: ['path1', 'path2'],
searchHotkeys: ['s'],
searchResultLength: 60,
search_options: {
encode: "icase",
tokenize: "forward",
resolution: 9,
doc: {
id: "key",
field: ["title", "content", "headers"],
}
}
}],
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
集成免费的第三方搜索服务algolia
# 输出pdf
安装export-site插件
npm i vuepress-plugin-export-site
1
引入
module.exports = {
plugins: [
[
'vuepress-plugin-export-site',{
extension: 'pdf'
}
]
]
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# 图片放大功能
# 评论插件
# Docusaurus
facebook的开源文档框架
# 搜索
docusaurus-prince-pdf插件