admin 管理员组

文章数量: 1184232

自动生成GFM目录

参考文献

引言

GFM即 github flavoured markdown ,是不支持自动生成目录的。

经过努力,实现了自动生成目录的方法。

在本仓库中有名为 gh-md-toc 的文件,在同步到本地后使用

chmod a+x gh-md-toc

改变其权限 虽然不知道有什么用

使用方法

对于本地文档

在写好 .md 文件后,执行类似于下面的命令。

➥ ./gh-md-toc ~/projects/Dockerfile.vim/README.md                                                                                                                                               
Table of Contents
=================
  * [Dockerfile.vim](#dockerfilevim)
  * [Screenshot](#screenshot)
  * [Installation](#installation)
        * [OR using Pathogen:](#or-using-pathogen)
        * [OR using Vundle:](#or-using-vundle)
  * [License](#license)

生成的即为目录内容,需要将目录内容粘贴至文档中需要生成目录的位置。

对于远程文档

➥ ./gh-md-toc 
Table of Contents
=================
  * [envirius](#envirius)
    * [Idea]

本文标签: 实战攻略 自动生成 文档