github markdown 目录生成

3,577 阅读1分钟

前言

最近发现 github 上的 markdown 文档不支持 [toc] 自动生成目录

image.png

那么别人是如何在 github 生成这种可点击跳转对应位置的目录呢?

image.png

然后就去百度了,通过下面语法格式编写 markdown 文档就可以生成目录

# 目录
- [一级标题](#一级标题)
- [二级标题](#二级标题)
	- [AAA](#aaa)
	- [bbb](#bbb)

但是标题很多怎么办,有没有一种自动生成该格式的方案呢?

然后找到一个在线网站 ecotrust-canada.github.io/markdown-to… ,但是它不支持中文标题!

image.png

最终解决方案

安装 vs 插件,插件名叫:Markdown All in One

如何生成 markdown 目录

  1. 安装好插件,进入文档对应目录,打开 markdown 文档,光标停在你想放目录的位置
  2. Ctrl / Cmd + Shift + p,打开命令输入框,输入 Create Table of Contents 回车,目录生成

image.png

image.png

  1. 其它命令,有兴趣自己去尝试一下
  • Update Table of Contents
  • Add/Update section numbers
  • Remove section numbers
  • Toggle code span
  • Toggle code block
  • Print current document to HTML
  • Print documents to HTML
  • Toggle math environment
  • Toggle list (It will cycle through list markers (-, *, +, 1. and 1)))

大家学会了吗