Markdown TOC 使用教程

Markdown TOC 使用教程

markdown-tocMarkdownTOC(Table Of Contents) Plugin for Visual Studio Code.项目地址:https://gitcode.com/gh_mirrors/mark/markdown-toc

项目介绍

Markdown TOC 是一个用于自动生成 Markdown 文件目录（Table of Contents, TOC）的工具。它可以帮助用户快速生成文档的目录结构，使得文档的导航更加方便。该工具支持多种编辑器，如 Emacs、Vim 和 VSCode，并且可以通过 npm 进行安装和使用。

项目快速启动

要快速启动并使用 Markdown TOC，请按照以下步骤操作：

1. 安装 Markdown TOC 使用 npm 安装 Markdown TOC：

   npm install -g markdown-toc
   

2. 编辑 Markdown 文件 在您的 Markdown 文件中，插入以下行以指定目录的插入位置：

   <!-- toc -->
   

3. 生成目录 使用以下命令生成并插入目录：

   markdown-toc -i README.md
   

应用案例和最佳实践

应用案例

假设您有一个名为 README.md 的 Markdown 文件，内容如下：

# 项目标题
## 第一节
### 子节1
## 第二节
### 子节2

在文件中插入 <!-- toc --> 后，运行 markdown-toc -i README.md 命令，文件将变为：

<!-- toc -->
- [项目标题](#项目标题)
  - [第一节](#第一节)
    - [子节1](#子节1)
  - [第二节](#第二节)
    - [子节2](#子节2)
<!-- tocstop -->
# 项目标题
## 第一节
### 子节1
## 第二节
### 子节2

最佳实践

• 保持标题的唯一性：确保每个标题都是唯一的，以避免目录生成时的冲突。
• 定期更新目录：在文档内容更新后，及时运行 markdown-toc 命令以更新目录。

典型生态项目

Markdown TOC 可以与其他 Markdown 相关工具和插件结合使用，以增强文档编辑和预览的体验。以下是一些典型的生态项目：

• VSCode 插件：如 Markdown Preview Enhanced (MPE)，可以在 VSCode 中提供更丰富的 Markdown 预览功能。
• Markdown 编辑器：如 Typora 和 Visual Studio Code，这些编辑器支持 Markdown 语法，并且可以与 Markdown TOC 结合使用。

通过这些工具和插件的结合使用，可以大大提高 Markdown 文档的编写和阅读效率。

markdown-tocMarkdownTOC(Table Of Contents) Plugin for Visual Studio Code.项目地址:https://gitcode.com/gh_mirrors/mark/markdown-toc