《技术点滴》- Markdown增强小工具 - 给 Markdown Header增加文档编号

markdown凭借其简单、方便、直接的写作方式,受到越来越多人的喜爱。

我们用markdown写文档时是否总喜欢用 header符号 #来给文章分段落,但是markdown不支持给段落编号,这使得我们总要手动为段落加上编号,这样很不方便,尤其是当段落修改时修改编号会带来大灾难。

markdownNumberHeader.js 脚本就是解决这个问题的大救星~

1 简介

本脚本用于给 Markdown 文档的Header加上文档编号,就像word文档一样,它会为你的md文档自动作这样的修改:

1
2
3
4
5
6
|#     ->    #1
|## -> ##1.1
|## -> ##1.2
|### -> ###1.2.1
|# -> #2
|## -> ##2.1

你可以使用它来转化你的 md文档(以 .md 为后缀),或是转化一个目录(它会自动遍历目录及其子目录里的所有md文档,并转化之)。

2 使用方法

1、clone the script

git clone https://github.com/luochenxun/markdown-number-md-header.git

2、Install it to your buildPath

`sudo cp ./markdownNumberHeader.js /usr/local/bin

2.1 安装

2.2 Usage

1
2
1\. markdownNumberHeader xxx/xxx/xxx.md
2\. markdownNumberHeader xxx/xxx/Diretory

3 项目地址

https://github.com/luochenxun/markdown-number-md-header