资讯专栏INFORMATION COLUMN

为 Markdown 文档生成 Table of Contents 的 Vim 插件

edagarli / 2186人阅读

摘要:使用编辑一个较长的文档时,如果想要手动维护是一件痛苦的事情,而且不同的解析引擎给标题生成的锚点链接并不一样,使用一款插件来替我们做这件事情会更方便。使用方法以发布到上的文档为例安装插件后在需要插入的地方运行即可。

使用 Vim 编辑一个较长的 Markdown 文档时,如果想要手动维护 Table of Contents 是一件痛苦的事情,而且不同的 Markdown 解析引擎给标题生成的锚点链接并不一样,使用一款插件来替我们做这件事情会更方便。

插件 GitHub 链接:https://github.com/mzlogin/vi...

开发这个插件的时候感受倒是没有多深刻,近期维护我的一个开源文档项目 awesome-adb(文档长度近 2000 行,各级标题超过 80 个)时才实实在在地体会到这样一个功能对使用 Vim 编辑 Markdown 文档的用户还是挺实用的,节省了很多时间。

插件效果截图

有此需求的童鞋可以 Star 收藏和试用起来,欢迎反馈和建议。

使用方法(以发布到 GitHub 上的 Markdown 文档为例):

安装插件后在需要插入 Table of Contents 的地方运行 :GenTocGFM 即可。

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/24884.html

相关文章

  • Markdown 文章目录在 Vim终极解决方案

    摘要:目前支持的解析引擎更新已经存在的文章目录。生成链接风格的文章目录。默认值用于控制保存文件时是否自动更新已有文章目录。我使用的与相关的插件解决文章目录的问题。 如果你使用 Vim 编辑 Markdown,而且也为如何生成和更新文章目录(Table of Contents)而烦恼,那么如下的内容将带你脱离刀耕火种手写 Toc 的体验,回归使用 Markdown 是为了专注于内容的初心。 一...

    cpupro 评论0 收藏0
  • Emacs:最好Python编辑器?

    摘要:这正是使用编辑器的基本形式。禁用启动消息即显示所有教程信息的页面。因此,只使用编辑器并且完美支持所有这些语言将会大大提高工作效率。结语正如你所见,明显是最好的编辑器。 本文是realpython.com继《将Sublime Text 3打造为Python全栈开发环境及》和《Vim与Python真乃天作之合》,又一篇关于如何配置Python IDE的文章。这一次,主角变成了与Vim同样...

    Shimmer 评论0 收藏0
  • Django搭建个人博客:渲染Markdown文章目录

    摘要:博文也是同样的,好的目录对博主和读者都很有帮助。文中的目录之前我们已经为博文支持了语法,现在继续增强其功能。修改文章详情视图文章详情目录扩展仅仅是将将扩展添加了进去。通过将目录传递给模板。 对会读书的人来说,读一本书要做的第一件事,就是仔细阅读这本书的目录。阅读目录可以对整体内容有所了解,并清楚地知道感兴趣的部分在哪里,提高阅读质量。 博文也是同样的,好的目录对博主和读者都很有帮助。更...

    Bamboy 评论0 收藏0
  • 面向web前端及node开发人员vim配置

    摘要:之后,在终端输入如果你需要支持,安装支持到这里还没有完,作为前端人,这个还不能正常工作,它需要一些依赖,下面我们来安装这些依赖安装查看回到目录安装之后需要在您的项目根目录建立一个文件,没有内容,空白即可。 鉴于 window 下基本用不到 vim,所以下面内容不再提及 window,具体可以在相应 github 中查看手册操作基础:已装有上有 nodejs(npm)。没装的可以移步官网...

    mo0n1andin 评论0 收藏0
  • 面向web前端及node开发人员vim配置

    摘要:之后,在终端输入如果你需要支持,安装支持到这里还没有完,作为前端人,这个还不能正常工作,它需要一些依赖,下面我们来安装这些依赖安装查看回到目录安装之后需要在您的项目根目录建立一个文件,没有内容,空白即可。 鉴于 window 下基本用不到 vim,所以下面内容不再提及 window,具体可以在相应 github 中查看手册操作基础:已装有上有 nodejs(npm)。没装的可以移步官网...

    Zoom 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<