一、概览
这是一个简单的 VSCode 插件,用来给 markdown 文本添加中文格式的序号,并增加顶部目录导航 ……
形如:
一、大标题1
(一)小标题1
(二)表标题2
二、大标题2
三、大标题3
如你所见,相比使用更为广泛的 Markdown All In One
插件(当然,“目录与序号”只是它丰富的功能之一),
1.大标题1
1.1小标题1
1.2表标题2
2.大标题2
3.大标题3
中文符号可能更加符合中文阅读者的审美 ……
二、用法
执行 Parse Serial
,如果一个文件已经用 md-serializer
处理过了,那么再次执行 Parse Serial
会更新原先的序号和目录。
执行 Clear Serial
三、配置
打开全局配置文件:
比如 mac: shift + cmd + p
, 输入并选择 Open Setting(JSON)
可配置如下参数:
"mdSerializer.options": {
"startLevel": 2, // 这个表示从什么级别的标题开始解析,默认为 2,低于这个级别的标题会被忽略,比如,设置为 3 的时候, '##' 和 '#' 的标题会被跳过;
"addDirectory": true, // 是否添加目录
"directoryLink": false, // 目录是否需要定位功能
},
四、更新
新增了全局配置参数:
---- 2021-12-18
支持第五层序号 —— 圆圈符号(①)
限制子标题最多 h6
---- 2022-03-29
完善了在 gitlab 上的目录导航
---- 2022-04-07
五、todo
- 添加快捷键
- 排除 ``` 内部的内容;
- 看看 id 有没有更好的方案;
- top 功能