MarkdownParse 插件技术文档

MarkdownParse 插件技术文档

1. 安装指南

环境要求

• Typecho 1.2.0 或更高版本
• PHP 8.1 或更高版本

安装步骤

1. 从 GitHub 发布页面 下载最新版本的插件。
2. 将下载的压缩包解压，并将文件夹重命名为 MarkdownParse。
3. 将 MarkdownParse 文件夹上传到 Typecho 的 usr/plugins/ 目录下。
4. 登录 Typecho 后台，进入“控制台” -> “插件管理”，找到 MarkdownParse 插件并启用。

2. 项目的使用说明

基本功能

MarkdownParse 插件基于 league/commonmark，完美符合 CommonMark 和 GFM 规范，支持以下功能：

• 目录生成
• 表格
• 任务列表
• 脚注

额外特性

1. Mermaid 语法支持：支持使用 Mermaid 语法创建各种图表。
2. MathJax 数学公式渲染：支持使用 MathJax 渲染数学公式。
3. 智能资源加载：根据实际渲染需求，智能识别是否加载渲染所需资源，避免引入冗余资源。
4. 图片延迟加载：支持浏览器原生的图片延迟加载技术，提升页面加载性能。
5. 文本高亮：通过 <mark> HTML 标签实现文本高亮效果。

语法示例

详细的 Markdown 语法示例可以参考 Markdown 简明语法手册。

3. 项目 API 使用文档

配置页面

启用插件后，可以在 Typecho 后台的“控制台” -> “插件管理”中找到 MarkdownParse 插件的配置页面。配置页面提供了以下选项：

• Mermaid 语法支持：启用或禁用 Mermaid 语法支持。
• MathJax 数学公式渲染：启用或禁用 MathJax 数学公式渲染。
• 图片延迟加载：启用或禁用图片延迟加载功能。
• 文本高亮：启用或禁用文本高亮功能。

自定义配置

插件支持通过修改配置文件进行自定义配置。配置文件位于 MarkdownParse/config.php，可以根据需要修改相关配置项。

4. 项目安装方式

手动安装

1. 下载插件压缩包。
2. 解压并重命名为 MarkdownParse。
3. 上传到 Typecho 的 usr/plugins/ 目录。
4. 在 Typecho 后台启用插件。

自动安装

Typecho 支持通过后台插件管理页面进行插件的自动安装。只需在插件管理页面点击“安装”按钮，系统会自动下载并安装插件。

通过以上步骤，您可以轻松安装并使用 MarkdownParse 插件，享受强大的 Markdown 解析功能。