03-生成可以在github显示的README目录【为什么github上的README.md无法显示[TOC]目录？】

参考

Github上的README.md等Markdown文件如何生成TOC文件目录

遇到的问题：为什么github上的README.md无法显示[TOC]目录？

Markdown可以使用[TOC]自动生成Markdown文件的标题目录，比如在typora，vscode(需要插件)等本地编辑器中。

但是Github却不支持[TOC]标签，所以在Github上使用[TOC]无法正确显示目录。

有时我们需要在Markdown文件里显示这样的结构效果：

网上大部分解决方案是使用网页生成工具gh-md-toc来生成Github的README.md的文件目录。安装后在终端输入命令就可以在终端里生成目录，但是也比较麻烦：因为是在终端生成的，复制粘贴到md文件里。

我发现的最简单的解决方案如下。

解决方案：vscode中的Markdown All in One插件

使用方法也很简单：

Step 1. 在vscode拓展中搜索Markdown All in One插件并下载，并在vscode打开需要生成目录的markdown文件

Step 2. 用vscode打开对应的md文件

Step 3.把光标移动到需要生成目录的地方

Step 4.使用快捷键command+shift+P（windows用户ctrl+shift+P），输入Markdown All in One: Create Table of Contents并回车

Step 5. 得到可以在Github的README.md中显示的目录，保存即可

Step 6.在git bash中把该文件同步到github仓库上：

//1.查看本地仓库的状态
git status

//2.把本地文件夹的修改，同步到到本地仓库上（add）
// . 表示全部修改
git add . 

//3.保存本地仓库的修改（commit）
git commit -m "message"

//4.把本地仓库的修改，同步到github远程仓库上（push）
git push

Step 7.查看github仓库，已经可以显示出目录（可以把那个[TOC]删掉啦）