自动生成 docsify 的 sidebar 和 每个子目录中的 sidebar
- 在 Github 页面右侧的 "Releases" 中下载编译好的软件
- 修改 Config 中的
HomePath为自己电脑上的目标根目录 - 双击 exe 执行
可以右键单击 exe, 创建快捷方式,
把这个 快捷方式 剪切到自己的项目根目录,
以后就不用每次都去找 exe 了
├─ DocsifyBuildSidebar
│ ├─Config
│ │ └─Config.json
│ └─DocsifyBuildSidebar.exe
└─ MyBlog
├─.git
├─index.html
└─DocsifyBuildSidebar.exe - 快捷方式
| 名称 | 说明 | 例子 |
|---|---|---|
| HomePath | Docsify 项目的根目录 | E:\\Work\\coding\\xxxue |
| IgnoreFile | 忽略的文件 (判断规则: 相等) | Readme.md |
| IgnoreDir | 忽略的目录 (判断规则: 相等) | .git |
| IgnoreDirNameContain | 忽略的目录 (判断规则: 目录名称任意位置包含) | .assets 匹配 *.assets* |
| DisableGenerateReadmeFile | 禁用 "生成 Readme.md 文件" (默认生成) | true (不生成) / false(生成)(默认值) |
- [C_Sharp](C_Sharp/)
- [test](C_Sharp/test/)
- [1](C_Sharp/test/1.md)
- [2](C_Sharp/test/2.md)
- [Utils](C_Sharp/Utils.md)
- [Java](Java/)
- [Github](Java/Github.md)
- [JavaScript](JavaScript/)
- [test](JavaScript/test/)
- [code](JavaScript/test/code.md)
- [test1](JavaScript/test/test1/)
- [te](JavaScript/test/test1/te.md)
- [test2](JavaScript/test/test1/test2/)
- [aaa](JavaScript/test/test1/test2/aaa.md)
- [Docsify](JavaScript/Docsify.md)
- [Github](JavaScript/Github.md)
- [Ubuntu](Ubuntu/)
- [Commands](Ubuntu/Commands.md)- [返回首页](/)
- [C_Sharp](C_Sharp/)
- [test](C_Sharp/test/)
- [1](C_Sharp/test/1.md)
- [2](C_Sharp/test/2.md)
- [Utils](C_Sharp/Utils.md)- [返回上一级 [C_Sharp]](C_Sharp/)
- [test](C_Sharp/test/)
- [1](C_Sharp/test/1.md)
- [2](C_Sharp/test/2.md)追求稳定, 可以把 css 与 js 文件保存到本地, 防止在国内有时候 cdn 连不上
比如 同级的 static 目录
html 中就改为 "static/docsify-sidebar-collapse.min.js"
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="viewport" content="width=device-width,initial-scale=1" />
<meta charset="UTF-8" />
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify@4/themes/vue.css" />
<!-- 文件夹样式 -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/sidebar-folder.min.css" />
<!-- 箭头样式 -->
<!-- <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/sidebar.min.css" /> -->
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
name: "Blog",
// 侧边栏文档目录
loadSidebar: true,
subMaxLevel: 2,
alias: {
"/.*/_sidebar.md": "/_sidebar.md",
},
// 跳转后自动到顶部
auto2top: true,
coverpage: true,
// --------------
// 页面右侧toc
toc: {
tocMaxLevel: 2,
target: "h2, h3, h4, h5, h6",
},
// 全文搜索
search: {
depth: 6,
noData: "没有搜到!",
placeholder: "搜索...",
// 避免搜索索引冲突,同一域下的多个网站之间
namespace: "website-1",
},
// 底部导航
pagination: {
previousText: "上一页",
nextText: "下一页",
crossChapter: true,
crossChapterText: true,
},
// 字数统计
count: {
countable: true,
position: "top",
margin: "10px",
float: "right",
fontsize: "0.9em",
color: "red",
language: "chinese",
localization: {
words: "",
minute: "",
},
isExpected: true,
},
};
</script>
<!-- docsify -->
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/docsify.min.js"></script>
<!-- 代码高亮 https://cdn.jsdelivr.net/npm/prismjs@1/components/ -->
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-python.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-cmake.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-java.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-csharp.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-docker.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/prismjs@1/components/prism-powershell.min.js"></script>
<!-- 多tab支持 -->
<script src="https://cdn.jsdelivr.net/npm/docsify-tabs@1/dist/docsify-tabs.min.js"></script>
<!-- 代码复制 -->
<script src="https://cdn.jsdelivr.net/npm/docsify-copy-code@2/dist/docsify-copy-code.min.js"></script>
<!-- 底部 上一页 / 下一页 -->
<script src="https://cdn.jsdelivr.net/npm/docsify-pagination@2/dist/docsify-pagination.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/external-script.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/ga.min.js"></script>
<!-- 全文搜索 -->
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
<!-- 图片放大缩小 -->
<script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/zoom-image.min.js"></script>
<!-- 字数统计 -->
<script src="https://cdn.jsdelivr.net/npm/docsify-count@latest/dist/countable.min.js"></script>
<!-- 侧边栏目录折叠 -->
<script src="https://cdn.jsdelivr.net/npm/docsify-sidebar-collapse/dist/docsify-sidebar-collapse.min.js"></script>
<!-- 页面右侧 TOC -->
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/docsify-plugin-toc.min.js"></script>
<!-- emoji -->
<script src="https://cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.min.js"></script>
</body>
</html>安装docsify.bat
@echo off
npm i docsify-cli -g运行docsify.bat
@echo off
docsify serve ./删除生成的 md 文件.ps1
# PowerShell 递归删除指定文件
# 定义排除目录列表，支持动态添加,
# 使用逗号分隔,比如: '.git', 'MoreDirName'
$excludeDirs = @('.git')
# 要删除的文件
Get-ChildItem -Recurse -File -Include "_sidebar.md", "README.md" |
Where-Object {
$path = $_.DirectoryName
-not ($excludeDirs | Where-Object { $path -like "*\$_" })
} |
Remove-Item -Force
Pause