README.zh.md

FileToc

为本地的 git 仓库生成 markdown 文件目录。链接到该文件的地址。

用 FileToc 生成的目录

• .vscode
  • settings.json
• dist
  • bundle.js
• lib
  • config.ts
  • constant.ts
  • createToc.ts
  • index.ts
  • utilis.ts
• .editorconfig
• .gitignore
• .npmignore
• .prettierignore
• .prettierrc
• filetoc.config.js
• index.js
• package.json
• pnpm-lock.yaml
• README.md
• README.zh.md
• rollup.config.js
• tsconfig.json

安装

npm install filetoc -g

使用

创建一个配置文件(filetoc.config.js)

例子

// filetoc.config.js
module.exports = {
  remoteUrl: 'https://github.com/chenfan0/dirtoc', // 你的仓库远程地址
  mainBranch: 'main', // 你的默认分支，默认为'main'
  dirPath: '.', //  你想要生成toc的目录地址. 默认 '.'
  mdPath: ['./README.md', './README.zh.md'], // markdown文件路径, 当只有一个路径时，也可写成字符串形式.  默认 ['README.md']
  excludes: ['.git'] // 不需要生成toc的文件名或者目录名
}

指定 toc 生成的位置

你应该在 markdown 文件中指定插入 toc 的位置

Example

<!--filetoc-start-->
<!--filetoc-end-->

执行 filetoc

进入到你本地仓库的目录，并且执行 filetoc 命令:

filetoc

配合git hooks使用

如果你想要在每次commit之前，自动帮你修改md文档。你可以借助husky来实现这个效果。

在终端执行如下命令

npx husky-init && npm install

在生成的husky文件夹下找到pre-commit文件，并在该文件中写入：

filetoc
git add .