MarkdownPad2AutoCatalog 插件使用手册

MarkdownPad2AutoCatalog 插件使用手册

MarkdownPad2AutoCatalog 项目地址: https://gitcode.com/gh_mirrors/ma/MarkdownPad2AutoCatalog

项目介绍

MarkdownPad2AutoCatalog 是一款专为 MarkdownPad2 编辑器设计的插件。通过运用 JavaScript 和 CSS 技术，本插件实现在将 Markdown 文件导出为 HTML 或预览时，自动生成带有导航目录的网页，并允许用户自定义网页样式。其特色功能包括自动化目录生成、目录项自动排序编号、多种目录样式切换、以及提供明亮与深色两种主题风格。此外，它集成了 highlight.js 以实现代码块的高亮显示。

项目快速启动

安装步骤

1. 下载插件资源：首先从 GitHub 仓库 下载最新发布的插件包。

2. 整合 CSS 样式：

   • 打开 MarkdownPad2，进入 工具 -> 选项 -> 样式表。
   • 点击“添加”，将下载解压后 dist/markdownPad2AutoCatalog.min.css 文件中的代码粘贴进去，并保存为一个新的 .css 文件。

3. 集成 JS 脚本：

   • 还是在 MarkdownPad2 中，前往 工具 -> 选项 -> 高级 -> Html Head编辑器。
   • 分别粘贴以下两段脚本代码：
     • <script src="path/to/markdownPad2AutoCatalog.min.js"></script> （替换为实际文件路径）
     • <script src="path/to/highlight.min.js"></script> （同样需要替换为实际路径）
   • 保存设置。

完成以上步骤后，当你预览或导出 Markdown 文件时，插件将自动为你创建目录。

快速体验代码示例

虽然直接的代码操作已在上一步说明，但如果你需要在 Markdown 中快速测试效果，确保你的 Markdown 文档含有各级标题（如 #, ##, ###等），预览时应自动生成对应目录。

# 我的文章标题

## 引言

### 第一小节

应用案例和最佳实践

在撰写技术文档、教程或笔记时，利用MarkdownPad2AutoCatalog插件可以极大提升文档的可读性和导航便捷性。推荐的做法是，在文档开头明确各部分标题，利用本插件自动生成目录，使得读者能够迅速定位到感兴趣的内容区域。对于长篇文档，这几乎是必不可少的功能。

典型生态项目

原项目MarkdownPad2AutoCatalog已经废弃，建议转向更新且功能更强大的替代品——Mdtht。Mdtht不仅保持了原有的功能，还增加了更高的执行效率和更多定制选项，如自动适应昼夜模式、更丰富的样式配置等。这进一步扩展了Markdown编辑器的生态系统，为用户带来了更佳的写作和阅读体验。

---

通过上述步骤和建议，你可以充分利用MarkdownPad2AutoCatalog及其继任者来优化你的Markdown文档处理流程，使内容创作更为高效且用户友好。

MarkdownPad2AutoCatalog 项目地址: https://gitcode.com/gh_mirrors/ma/MarkdownPad2AutoCatalog