MarkdownTOC 项目常见问题解决方案

MarkdownTOC 项目常见问题解决方案

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

项目基础介绍

MarkdownTOC 是一个为 Visual Studio Code 开发的插件，主要用于生成 Markdown 文件的目录（Table Of Contents）。该插件支持自动插入目录、插入标题编号、深度控制等功能，极大地提高了 Markdown 文档的阅读体验和编辑效率。

主要的编程语言是 TypeScript，这是 Visual Studio Code 插件开发的标准语言。

新手使用注意事项及解决方案

1. 安装插件后无法生成目录

问题描述：安装 MarkdownTOC 插件后，尝试在 Markdown 文件中生成目录，但没有任何反应。

解决步骤：

1. 检查插件是否正确安装：确保插件已成功安装并启用。可以在 Visual Studio Code 的扩展管理器中查看插件状态。
2. 重启 Visual Studio Code：有时插件安装后需要重启编辑器才能生效。
3. 手动插入目录标记：在 Markdown 文件中手动插入目录标记，例如 <!-- TOC --> 和 <!-- /TOC -->，然后保存文件。
4. 检查配置：确保插件的配置项没有被错误修改，特别是 updateOnSave 是否设置为 true。

2. 生成的目录深度不符合预期

问题描述：生成的目录深度与预期不符，例如只显示了部分标题。

解决步骤：

1. 检查深度配置：在 Visual Studio Code 的设置中，找到 markdown-toc.depthFrom 和 markdown-toc.depthTo 配置项，确保它们的值符合预期。
2. 手动调整深度：如果默认配置不符合需求，可以在 Markdown 文件中手动插入深度配置，例如 <!-- TOC depthFrom:2 depthTo:4 -->。
3. 保存文件：修改配置后，保存文件以触发目录更新。

3. 生成的目录链接无法跳转

问题描述：点击生成的目录链接后，页面无法跳转到对应的标题位置。

解决步骤：

1. 检查标题格式：确保 Markdown 文件中的标题格式正确，例如使用 #、## 等符号标记标题。
2. 检查链接生成模式：在 Visual Studio Code 的设置中，找到 markdown-toc.anchorMode 配置项，确保其值为 github.com 或其他支持的模式。
3. 手动插入锚点：如果自动生成的锚点有问题，可以手动在标题前插入锚点，例如 <a id="markdown-header"></a>。

通过以上步骤，新手用户可以更好地使用 MarkdownTOC 插件，解决常见问题，提高 Markdown 文档的编辑效率。

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