目录生成 #

概述 #

目录（Table of Contents，TOC）用于展示文档结构，方便读者快速导航。

手动目录 #

创建目录链接 #

markdown

## 目录

- [简介](#简介)
- [安装](#安装)
- [使用](#使用)
- [API](#api)
- [常见问题](#常见问题)

## 简介

内容...

## 安装

内容...

## 使用

内容...

## API

内容...

## 常见问题

内容...

锚点命名规则 #

标题	锚点
`## 简介`	`#简介`
`## Hello World`	`#hello-world`
`## API 文档`	`#api-文档`
`## v1.0 版本`	`#v10-版本`

锚点规则 #

转换为小写
空格变为连字符
特殊字符通常保留或移除
不同平台规则可能不同

自动目录 #

GitHub 风格 #

部分平台支持自动生成目录：

markdown

[[_TOC_]]

或

markdown

[[toc]]

Obsidian #

markdown

[[toc]]

Hugo #

markdown

{{< toc >}}

VuePress #

markdown

[[toc]]

Docusaurus #

markdown

```toc

text


## 目录深度控制

### 限制目录层级

部分平台支持：

```markdown
[[toc levels=3]]

或

markdown

<!-- toc depth=2 -->

手动控制 #

markdown

## 目录

- [一级标题](#一级标题)
  - [二级标题](#二级标题)
    - [三级标题](#三级标题)

目录样式 #

简洁样式 #

markdown

## 目录

- [简介](#简介)
- [安装](#安装)
- [使用](#使用)

带描述样式 #

markdown

## 目录

- [简介](#简介) - 项目概述
- [安装](#安装) - 安装指南
- [使用](#使用) - 使用方法

带编号样式 #

markdown

## 目录

1. [简介](#简介)
2. [安装](#安装)
3. [使用](#使用)

实际应用 #

README 目录 #

markdown

# 项目名称

简短描述...

## 目录

- [功能特性](#功能特性)
- [安装](#安装)
- [快速开始](#快速开始)
- [API 文档](#api-文档)
- [贡献指南](#贡献指南)
- [许可证](#许可证)

## 功能特性

内容...

## 安装

内容...

文档目录 #

markdown

# 使用指南

## 目录

- [概述](#概述)
- [基础用法](#基础用法)
  - [创建项目](#创建项目)
  - [配置选项](#配置选项)
- [高级用法](#高级用法)
  - [自定义主题](#自定义主题)
  - [插件开发](#插件开发)
- [常见问题](#常见问题)

## 概述

内容...

目录位置 #

文档开头 #

markdown

# 标题

## 目录

- [章节1](#章节1)
- [章节2](#章节2)

## 章节1

内容...

侧边栏 #

部分文档系统自动在侧边栏显示目录。

常见问题 #

问题1：链接跳转失败 #

检查：

锚点是否正确
标题是否存在
特殊字符处理

问题2：自动目录不生成 #

检查：

平台是否支持
语法是否正确

问题3：目录层级混乱 #

markdown

好的：
## 目录
- [二级](#二级)
  - [三级](#三级)

不好的：
## 目录
- [二级](#二级)
- [四级](#四级)  ← 跳级

最佳实践 #

1. 长文档添加目录 #

markdown

超过 3 个章节的文档建议添加目录

2. 目录与标题一致 #

markdown

好的：
- [安装指南](#安装指南)
## 安装指南

不好的：
- [安装](#安装指南)
## 安装指南

3. 定期更新目录 #

markdown

添加新章节后记得更新目录

4. 使用自动目录 #

markdown

如果平台支持，优先使用自动目录

下一步 #

继续学习写技术文档！