Windows下VSCODE使用MarkADown TOC插件,自动生成目录

一、背景

笔者通常是在vscode中书写markdown博客,但是发现无法使用其他平台,比如typora的[TOC]命令来生成目录,之后发现通过插件Markdown TOC来生成目录,效果还不错,所以记录一下使用方法,希望能够给需要的朋友一些帮助。

二、下载Markdown TOC插件

(1)方法1

(1)点击左下角"Manage"按钮,打开Extensions插件页面
(2) 搜索"Markdown TOC",点击下载
在这里插入图片描述

(2)方法2

(1)直接键盘快捷键ctrl+shift+x唤出插件页面
(2)搜索"Markdown TOC",点击下载

(3)方法3

(1)ctrl+shift+p唤出控制台
(2)键入命令ext install markdown-toc直接下载

二、使用方法

1、生成目录

1、点击鼠标右键,发现选项栏里多了四个markdown相关的选项,其解释如下:
在这里插入图片描述
2、点击Markdown TOC:Insert/Update生成目录
如下图所示:
(鼠标右键,Markdown TOC:Delete选项删除目录)
在这里插入图片描述
预览效果如下:

在这里插入图片描述

2、为目录添加数字索引

鼠标右键,点击Markdown Sections:Insert/Update,即可为目录生成数字索引。

在这里插入图片描述

3、插件配置选项

插件官方文档里有插件选项配置,如下所示:

在这里插入图片描述

4、生成不带跳转链接的目录

withLinks:false选项插入<!-- TOC -->,即可生成不带跳转链接的目录
在这里插入图片描述

5、指定目录深度

如果只想展示从二级标题到四级标题的目录,可以在<!-- TOC -->中添加选项depthFrom:2 depthTo:4
在这里插入图片描述
注意:此处笔者是将键入好的选项直接拷贝<!-- TOC -->中,好像无法直接在<!-- TOC -->中键入选项。

三、Windows下可能出现的问题

1、问题产生与分析

笔者第一次使用此插件时,出现了如下问题,VSCode中Markdown目录显示异常,无法生成目录:
在这里插入图片描述
查看生成的目录格式,发现可能是换行符出现了问题,所以对此进行设置。

2、问题解决

点击界面左下方的设置按钮,然后选择设置进入到用户设置界面。
打开用户设置之后在搜索设置里面搜索Eol。
找到文件的Eol可以看到默认行尾字符设置为auto。
在这里插入图片描述

点击选项框然后将auto更改为\n换行符即可。
在这里插入图片描述

回到Markdown编辑界面然后重新生成Markdown目录就能显示正常了。

  • 4
    点赞
  • 13
    收藏
  • 打赏
    打赏
  • 4
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
©️2022 CSDN 皮肤主题:数字20 设计师:CSDN官方博客 返回首页
评论 4

打赏作者

北-落

你的鼓励将是我创作的最大动力

¥2 ¥4 ¥6 ¥10 ¥20
输入1-500的整数
余额支付 (余额:-- )
扫码支付
扫码支付:¥2
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值