写了一款Jetbrains插件,为了Markdown

1. markdown-index

最近做了一个Jetbrains的插件，叫markdown-index，它的作用是为Markdown文档的标题自动添加序号，效果如下：

markdown-index使用效果

目前已经可以在Jetbrains全家桶的插件市场中搜索到。

插件已上架

2. 为什么我要做这个插件

我习惯用Markdown写完文章之后给文章标题添加上序号，这样读者阅读起来会更清晰，像这样：

序号让阅读更清晰

之前我都是用Typora写完文章之后，把文章复制到VSCode中，然后使用VSCode中的markdown-index插件给文章标题自动添加序号，然后再复制文章内容进行分发。

本来可以一直沿用这个方式，可是在我最近使用VuePress搭建了个人博客之后，在博客写作这个方向上我慢慢偏向了WebStorm，原因有3个：

1. 在本地调试的时候我更喜欢一键启动，而不需要每次打开Terminal输入npm run docs:dev命令；

   

2. 我配置了git push之后的网站自动部署流，由于平时开发用惯了IDEA，因此WebStorm的git用户界面让我感觉更亲切；

3. VSCode的markdown-index插件使用尽管已经很方便了，但是还是稍微有点繁琐，因为必须先Command+Shift+p调出command palette，然后选择markdown-index功能。我想直接鼠标右键直接选择markdown-index功能。

综合上面3点原因，我参考了VSCode的markdown-index插件，查阅文档，花了一晚上写了Jetbrains全家桶的markdown-index插件。

下面给大家介绍一下插件从0到1的编写流程以及在查阅官方文档时的一些心得体会。

3. 插件开发前奏

一开始图省事儿，想直接根据网友的插件开发经验来做，但发现要么资料过时，要么是跟着做了不成功，最后索性直接找官方文档了。

因此这个小插件90%的时间都花在了阅读官方文档上了。

3.1. 官方文档

我们一开始肯定不知道官方文档的地址，想直接从Jetbrains门户网站找到插件开发的官方文档也很浪费时间。我提供两种方案：

1. 使用百度搜索，搜索「Jetbrains插件开发」之类的关键词，找到网友之前分享的开发博客，一般写的详细的博客（可能需要多找几篇）会给出官方地址，然后，抛弃这篇文章，投入官方文档的怀抱吧。

2. 使用Google搜索，搜索英文关键词，比如「jetbrains plugin development」，一般第一条就是我们要找的结果，这也是我采取的方法（不得不感叹一句，Google搜索英文资料真的是好～）。

   

现在官方网站就到手了：https://plugins.jetbrains.com/docs/intellij/getting-started.html

官方文档一般情况下写得都非常详细，尤其是掺杂着各种超链接。大家在读官方文档的时候如果不是十分清楚超链接的含义，尽量不要点，否则跳来跳去很容易把心态搞崩。

3.2. 开发插件的3种方式

官方说明了开发插件的三种方式，分别是：

1. 使用官方发布在GitHub上的插件模板（Using GitHub Template）

2. 使用Gradle（Using Gradle）

3. 使用DevKit（Using DevKit）

我选择的是第一种，原因是我之前