在Markdown文档中添加目录的方法

在Markdown文档中添加目录有多种方法，下面介绍几种常用的方式：

一、自动生成目录（部分编辑器/平台支持）

1.使用 [TOC] 标记（Typora、部分GitHub项目等）

@[toc] # 标题1 ## 标题2 ### 标题3

2.使用插件/扩展

• VS Code：安装Markdown All in One插件，按Ctrl+Shift+P输入 “Create Table of Contents”
• Obsidian：使用[[TOC]]或安装目录插件

二、手动创建目录（通用方法）

1.基本目录结构

# 文章标题 ## 目录 - [一、简介](#一简介) - [二、安装](#二安装) - [2.1 环境要求](#21-环境要求) - [2.2 安装步骤](#22-安装步骤) - [三、使用](#三使用) - [四、常见问题](#四常见问题) ## 一、简介 这里是简介内容... ## 二、安装 ### 2.1 环境要求 ### 2.2 安装步骤 ## 三、使用 ## 四、常见问题

2.创建锚点链接

[跳转到第一章](#第一章) # 第一章 内容...

三、使用工具自动生成

1.命令行工具

# 使用 doctoc 工具npminstall-g doctoc doctoc README.md

2.在线工具

• Markdown 目录生成器
• GitHub 的 TOC 生成

四、优化技巧

1.美化目录样式

<details> <summary>点击展开目录</summary> - [第一章](#第一章) - [第二章](#第二章) </details>

2.带序号的目录

1. [简介](#简介) 2. [安装](#安装) 1. [环境要求](#环境要求) 2. [安装步骤](#安装步骤)

3.GitHub兼容的锚点规则

• 标题中的标点会被忽略
• 空格转换为-
• 大写字母转换为小写
• 如## 2.1 Hello World!的锚点是#21-hello-world

五、最佳实践示例

# 项目文档 <!-- TOC --> - [项目简介](#项目简介) - [快速开始](#快速开始) - [前置要求](#前置要求) - [安装步骤](#安装步骤) - [使用指南](#使用指南) - [基本用法](#基本用法) - [高级功能](#高级功能) - [API参考](#api参考) - [常见问题](#常见问题) <!-- /TOC --> ## 项目简介 ... ## 快速开始 ### 前置要求 ### 安装步骤 ## 使用指南 ### 基本用法 ### 高级功能 ## API参考 ## 常见问题

注意事项

1. 锚点一致性：确保目录中的链接与标题完全一致
2. 层级清晰：合理使用缩进表示层级关系
3. 及时更新：文档修改后同步更新目录
4. 平台兼容性：不同平台（GitHub、GitLab、Gitee等）对目录支持可能不同

选择哪种方法取决于你的使用场景和编辑器支持情况。对于需要跨平台分享的文档，建议使用手动创建的方法以确保兼容性。