问题说明
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. 使用快捷键command+shift+P
(windows用户ctrl+shift+P
),输入Markdown All in One: Create Table of Contents
并回车
Step 3. 得到可以在Github的README.md中显示的目录,复制粘贴即可