Skip to content

tim5wang/build_docsify_sidebar

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 

Repository files navigation

build_docsify_sidebar

遍历docsify目录,生成_sidebar.md文件,支持嵌套的多层目录,支持返回上一级

使用方法:

在你的docsify文档项目的根目录执行

node ./build_sidebar.js

生成说明:

/**
 * @author tim5wang
 * 用于自动生成 docsify的 `_sidebar.md` 格式目录文件
 * 1. 支持多层目录嵌套,在根目录生成全局目录树 `./_sidebar.md`
 * 2. 在每层子目录生成该目录的 `子目录/_sidebar.md` 和 `README.md`
 * 3. 在根目录索引全部图片文件路径 `_images.md` 和 `_images.txt`
 * 
 * `_sidebar.md` 内容格式定义如下:
 * 
 * 文件层次用`-`前面的空格数表示n级列表 
 * ```md
 * - [目录名](完整目录/) 
 *  - [文件名1](完整目录/文件名1.md) 
 *  - [文件名2](完整目录/文件名2.md) 
 *  - [子目录名](完整子目录/)
 *   - [文件名3](完整目录/文件名3.md)
 * ```
 * 
 *
 *
 * 对应的`EADME.md` 内容格式定义如下:
 * 
 * 文件层次用标题级别表示: 如三层目录 ### [底层目录名](完整三级目录/)
 * ```md
 * # [目录名](完整目录/) 
 * ## [文件名1](完整目录/文件名1.md) 
 * ## [文件名2](完整目录/文件名2.md) 
 * ## [子目录名](完整子目录/)
 * ###[文件名3](完整目录/文件名3.md)
 * ```
 *
 注意:README.md为了docsify的sidebar的美观,其内容改为和_sidebar.md一致的形式
 * 
 * 图片文件索引 `_images.md`
 * ```md
 * ![图片1名](图片1完整路径)
 * ![图片2名](图片2完整路径)
 * ```
 * 
 * 图片文件索引 `_images.txt`
 * 
 * 图片1完整路径
 * 图片2完整路径
 */

About

遍历docsify目录,生成_sidebar.md文件

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published