实用帖 | 如何为 Markdown 文件(例如gitHub readme文件)自动生成目录?

本文介绍如何使用VisualStudioCode和MarkdownTOC扩展为Markdown文件自动生成目录。通过简单的步骤即可为FAQ文档等添加清晰的导航结构。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

在 Markdown:写技术文档、个人博客和读书笔记都很好用的轻量级标记语言这篇文章中,给大家介绍了 Markdown 及其创始人的故事、Markdown 基本语法、常见的 Markdown 编辑器(Mac/Windows 平台和在线编辑器)。

新接触 Markdown 的小伙伴建议先戳那篇文章去补充点能量,已熟悉 Markdown 的小伙伴可以速往下看。

在使用 Markdown 写文档时,有时需要给单个文档生成目录,比如包含多个问题的 FAQ (Frequently Asked Questions) 文档。

那么,如何为 Markdown 文件(即 .md 格式的文件)自动生成目录呢?

使用Visual Studio Code + Markdown TOC 扩展

Visual Studio Code + TOC 扩展
Visual Studio Code (VS Code) 是一个由微软开发的,同时支持 Windows、Linux 和 macOS 操作系统的开源文本编辑器。它支持调试,内置了 Git 版本控制功能,同时也具有开发环境功能,例如代码补全、代码片段、代码重构等。

这里写图片描述

VS Code 编辑器支持用户自定义配置,例如改变主题颜色、键盘快捷方式、编辑器属性和其他参数。另外,还支持扩展程序,并在编辑器中内置了扩展程序管理的功能。

到底如何使用 VS Code + TOC 扩展为 Markdown 文件自动生成目录呢?具体操作步骤如下:

  1. 下载和安装 Visual Studio Code。

下载地址:https://code.visualstudio.com/download

这里写图片描述

  1. 单击 VS Code 的扩展图标,在搜索框搜索 Markdown TOC 并安装。

此扩展长这样:

这里写图片描述

安装成功后,点击左侧扩展图标,可查看已安装的扩展。如下图所示:

这里写图片描述

  1. 点击菜单栏的文件 -> 打开,打开需要生成目录的 .md 格式的文件。

  2. 将光标移至需要插入目录的位置,右键单击 Markdown TOC: Insert/Update [^M T],目录即自动插入。

这里写图片描述

  1. 单击右上角的预览图标,可查看目录的显示效果。

这里写图片描述

评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值