Docsify Sidebar Plugin

这是一款超级便捷、超级实用、简单且优雅的生成_sidebar.md的方案。作者可以专注于内容创作、一键生成内容目录。

1. 开源MIT。
2. 灵活、轻便、简单、美观
3. 支持一次性生成多级目录
4. 新增文档后，支持目录追加
5. 允许用户自定义侧边栏的生成规则
   1. 支持为导航添加了有趣的emoji图标
   2. 支持忽略文件或目录
   3. 支持自定义生成内容
6. 新增文件夹，自动创建README.md
7. 自动记录侧边栏更新时间

维护计划

• 完成基本功能
• 完成测试和优化
• 重构为docsify插件
• 增加灵活性，如部分配置参数允许在index.html中自定义
• 增加docsify侧边栏配置参数化
• 可以通过 scripts 字段定义自定义命令，并支持传递参数。

使用说明

要使用该脚本，可以按照以下步骤操作：

1. 确保你已经安装了 Node.js。

2. 已配置自定义参数sidebar.conf.json（不配置则使用默认参数）

3. 打开终端或命令提示符。

4. 导航到包含 docsify-sidebar-plugin.js 文件的目录。

5. 运行以下命令来执行脚本，并传递一个相对路径参数： node docsify-sidebar-plugin.js <relative-path>

   例如，如果你想要生成 _sidebar.md 文件的目录是 docs，你可以运行：

   node docsify-sidebar-plugin.js docs

6. 也可以通过 scripts 字段定义自定义命令，并支持传递参数。例如：npm run gen docs

确保在运行脚本之前，目标目录中有一些 Markdown 文件和子目录，以便脚本能够生成内容。

提示：目前版本(V 1.0))通过获取脚本位置作为根目录，命令行输入参数为相对路径。所以建议将文件放在docsify的根目录下(与index.html同级)。

示例Demo

执行

...
PS F:\Docsify> cd .\docs\
PS F:\Docsify\docs> node docsify-sidebar-plugin.js /zh-cn/home2
》》_sidebar.md path: F:\Docsify\docs\zh-cn\home2\_sidebar.md
》》README.md Write succeeded: F:\Docsify\docs\zh-cn\home2
》》README.md Write succeeded: F:\Docsify\docs\zh-cn\home2\mc
》》_sidebar.md Append succeeded
PS F:\Docsify\docs>

效果

参与开发维护说明

可以使用任意编程工具，但需要注意无需修改mini.js，可以通关脚本直接生成新的文件

terser docsify-sidebar-plugin.js -o docsify-sidebar-plugin.min.js