Generate TOC(一键制作目录) 插件说明文档

插件信息

一键制作一个可链接的目录, 根据当前文档中的heading(等级标题)自动生成。如果已经生成，再次点击会进行更新，不会自动更新，防止占用线程导致变卡。配合admonition，效果更佳！如果不配合admonition，可以勾选去掉代码框。

安装方法

1. 下载最新的插件压缩包并解压到插件目录中。
2. 打开Obsidian应用，进入设置页面。
3. 在“社区插件”选项卡中启用“Generate TOC(一键制作目录)”插件。

使用说明

1. 打开或创建一个文档。
   • 
2. 点击插件提供的命令 “Generate TOC(一键生成目录)” 来生成目录。
   • 
3. 插件会根据文档中的heading（标题）生成一个可链接的目录，并插入到文档中。
   • 
4. 如果需要更新目录，只需再次点击命令即可。
   • 

设置选项

• 启用代码块: 是否启用代码块来包裹生成的目录。建议启用，如果禁用代码块，后续更新目录可能会导致误删文档或漏删之前的目录。禁用代码块前请备份文档并设置好头尾标识。
• 代码块标题: 自定义代码块的标题。
• 标题内容: 自定义目录的标题内容。可以选择是否启用自定义标题。
• 颜色内容: 自定义目录的颜色。可以选择是否启用自定义颜色。
• 折叠设置: 选择目录是否折叠。可以选择折叠状态为“开”或“关”。
• 无代码块头部标识: 设置无代码块时的头部标识。
• 无代码块尾部标识: 设置无代码块时的尾部标识。

设置示例

1. 启用代码块：

   • 进入设置页面，找到“启用代码块”选项，勾选启用。
   • 在“代码块标题”中输入自定义标题，例如：ad-toc。

2. 自定义标题内容：

   • 进入设置页面，找到“标题内容”选项，勾选启用。
   • 在文本框中输入自定义标题内容，例如：目录。

3. 自定义颜色：

   • 进入设置页面，找到“颜色内容”选项，勾选启用。
   • 选择或输入自定义颜色，例如：#6496FF。

4. 设置折叠：

   • 进入设置页面，找到“折叠设置”选项，勾选启用。
   • 在下拉菜单中选择“开”或“关”。

5. 设置无代码块标识：

   • 进入设置页面，找到“无代码块头部标识”和“无代码块尾部标识”选项，分别输入自定义标识内容。

注意事项

• 在禁用代码块的情况下，请务必备份文档并正确设置头尾标识，防止后续更新目录时误删文档内容。
• 使用插件过程中，如遇到问题或需要更多帮助，请访问作者的GitHub页面进行反馈。

感谢使用 Generate TOC(一键制作目录) 插件，愿您的文档管理更加高效便捷！