Markdown-TOC 技术文档

Markdown-TOC 技术文档

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

1. 安装指南

1.1 安装方式

要安装 Markdown-TOC 插件，请在命令行中运行以下命令：

ext install markdown-toc

2. 项目使用说明

2.1 插入目录

Markdown-TOC 插件可以帮助你在 Markdown 文件中自动生成目录。你可以在文件中插入 <!-- TOC --> 标签，插件会自动在该位置生成目录。

2.2 插入标题编号

你还可以为标题插入编号，使目录更加有序。标题编号从 depthFrom 指定的深度开始。

3. 项目API使用文档

3.1 配置参数

Markdown-TOC 提供了多种配置参数，允许用户自定义目录的生成方式。以下是主要的配置参数及其默认值：

| 属性 | 值类型 | 默认值 | |---------------|--------------|--------| | depthFrom | uint(1-6) | 1 | | depthTo | uint(1-6) | 6 | | insertAnchor | bool | false | | withLinks | bool | true | | orderedList | bool | false | | updateOnSave | bool | true | | anchorMode | enum | github.com |

3.2 默认设置

你可以通过编辑用户或工作区设置来更改 Markdown-TOC 的默认配置。以下是可用的设置及其默认值：

| 属性 | 值类型 | 默认值 | |-----------------------|--------------|--------| | markdown-toc.depthFrom| number(1-6) | 1 | | markdown-toc.depthTo | number(1-6) | 6 | | markdown-toc.insertAnchor | bool | false | | markdown-toc.withLinks| bool | true | | markdown-toc.orderedList | bool | false | | markdown-toc.updateOnSave | bool | true | | markdown-toc.anchorMode | enum | github.com |

3.3 自定义设置

如果你希望为某个文件使用独特的设置，可以在 <!-- TOC --> 标签中添加属性，例如：

<!-- TOC depthFrom:2 orderedList:true -->

<!-- /TOC -->

4. 项目安装方式

Markdown-TOC 插件可以通过以下命令安装：

ext install markdown-toc

5. 贡献者

感谢以下贡献者对项目的贡献：

• sine sawtooth (添加：标题编号功能)
• chriscamicas (更新：锚点生成)
• kevindaub (添加：使用工作区设置)
• rovest (功能：插入锚点)
• zhiguang Wang (修复：代码块识别错误)
• jgroom33 (修复：代码块错误)
• satokaz (修复：代码块错误)

6. 更新日志

查看 CHANGELOG 了解最新更新。

7. 问题反馈

如果你有任何问题，可以通过以下方式联系我：

• 邮箱：alanwalk93@gmail.com
• Twitter：@AlanWalk93
• Github：AlanWalk

8. 许可证

该项目是开源软件，遵循 MIT License。由 AlanWalk 开发。

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