经常使用markdown 的玩家一定很想要一个自动生成的导航栏吧,自己写的基本思路就是
轮询监听滚动条的位置,通过抛锚和跳锚实现,这里介绍一下今天的主角,markdown-toc插件:
https://github.com/jonschlinkert/markdown-toc
# 0x00 安装
TOC = Table of content , 将内容制作成导航
这个插件是基于 nodejs 的,因此需要安装 node 和 npm ,这里同样采用nvm的形式安装
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash source ~/.bashrc nvm list-remote nvm install v10.16.0 node -v
安装好nvm后,就可以使用npm 安装插件了
npm install --save markdown-toc
# 0x01 命令行
经常使用markdown 的玩家一定很想要一个自动生成的导航栏吧,自己写的基本思路就是
轮询监听滚动条的位置,通过抛锚和跳锚实现,这里介绍一下今天的主角,markdown-toc插件:
这个插件带Cli命令,使用帮助如下
markdown-doc [选项] <输入>
<输入> 表示需要使用 TOC 的 markdown 文件,可以通过标准输入读取
[选项]
-i | 直接往 <输入> 的文件注入TOC标识符: <!-- toc -->,如果没有这个参数就输出到屏幕,不修改md文件 |
--json | 通过json格式打印TOC |
--append | 在字符串的后面追加TOC |
--bullets | 指定需要被生成TOC项的标识符号,可以指定多个: --bullets "* |