Github上的README.md等Markdown文件如何生成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. 使用快捷键command+shift+P(windows用户ctrl+shift+P),输入Markdown All in One: Create Table of Contents并回车

Step 3. 得到可以在Github的README.md中显示的目录,复制粘贴即可

  • 5
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 6
    评论
评论 6
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值