初始化安装项目
全局安装
# 全局安装docsify-cli
npm i docsify-cli -g
初始化项目
# 初始化docs目录
docsify init ./docs
启动项目
# 启动项目
docsify serve docs
注意:docs为文件夹名称,需要在文件夹外启动
CDN
<!-- 引入 css -->
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4.10.2/themes/vue.css">
<!-- 引入 script -->
<script src="//cdn.jsdelivr.net/npm/docsify@4.10.2/lib/docsify.js"></script>
其他cdn
- https://www.bootcdn.cn/docsify/ (支持国内)
- https://cdn.jsdelivr.net/npm/docsify/ (国内外都支持)
- https://cdnjs.com/libraries/docsify
- https://unpkg.com/browse/docsify/
侧边栏添加
加载自定义侧边栏,设置为 true
后会加载 _sidebar.md
文件,也可以自定义加载的文件名。
window.$docsify = {
// 加载 _sidebar.md
loadSidebar: true,
// 加载 summary.md
loadSidebar: '_sidebar.md',
};
_sidebar.md文件
* 入门
* [快速开始](quickstart.md)
* [多页文档](more-pages.md)
* [定制导航栏](custom-navbar.md)
* [封面](cover.md)
* 定制化
* [配置项](configuration.md)
* [主题](themes.md)
* [插件列表](plugins.md)
* [代码高亮](language-highlight.md)
插件
表情插件
在index.html
中新增:
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.min.js"></script>
:100:
=> 💯
搜索插件
在index.html
中新增:
<script>
window.$docsify = {
search: 'auto', // 默认 auto
}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
或
<script>
window.$docsify = {
// 设置后只搜索这几个目录
search : [
'/', // => /README.md
'/guide', // => /guide.md
'/get-started', // => /get-started.md
'/zh-cn/', // => /zh-cn/README.md
]
}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
或
<script>
window.$docsify = {
search: {
maxAge: 86400000, // 到期时间
paths: [], // 可以设置搜索的目录
placeholder: 'Type to search', // 搜索框提示
noData: 'No Results!', // 无结果时显示的文字
depth: 2, // 深度
hideOtherSidebarContent: false, // .隐藏其他侧边栏内容
}
}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
图片缩放插件
在index.html中新增
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>