Typecho Markdown 插件安装与配置指南

Typecho Markdown 插件安装与配置指南

typecho-markdown A markdown parse plugin for typecho. 项目地址: https://gitcode.com/gh_mirrors/ty/typecho-markdown

1. 项目基础介绍和主要编程语言

Typecho Markdown 插件是一个为 Typecho 博客系统开发的 Markdown 解析插件。该插件基于 league/commonmark 库，旨在提供符合 CommonMark 和 GFM（GitHub-Flavored Markdown）规范的 Markdown 解析功能。主要编程语言为 PHP。

2. 项目使用的关键技术和框架

• PHP: 作为主要编程语言，负责插件的核心逻辑和功能实现。
• league/commonmark: 一个高性能的 Markdown 解析库，支持 CommonMark 和 GFM 规范。
• Mermaid: 用于支持图表的绘制。
• MathJax: 用于支持数学公式的渲染。
• MDN-Lazy loading: 用于图片的延迟加载。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

1. Typecho 版本要求: 确保你的 Typecho 版本为 1.2.0 或更高。
2. PHP 版本要求: 确保你的 PHP 版本为 8.1 或更高。
3. 下载插件: 从 GitHub 仓库下载插件的 ZIP 文件。

详细安装步骤

1. 下载插件:

   • 访问 GitHub 仓库。
   • 点击右上角的 "Code" 按钮，选择 "Download ZIP"。

2. 解压文件:

   • 将下载的 ZIP 文件解压到本地目录。
   • 解压后，你会看到一个名为 typecho-markdown-master 的文件夹。

3. 重命名文件夹:

   • 将 typecho-markdown-master 文件夹重命名为 MarkdownParse。

4. 上传插件:

   • 将 MarkdownParse 文件夹上传到 Typecho 的插件目录中。通常路径为 usr/plugins/。

5. 启用插件:

   • 登录到 Typecho 后台。
   • 导航到 "控制台" -> "插件"。
   • 找到 "MarkdownParse" 插件，点击 "启用"。

6. 配置插件:

   • 启用插件后，你可以在插件列表中找到 "MarkdownParse"，点击 "设置" 进行配置。
   • 根据需要配置插件的各项功能，如 Mermaid 语法支持、MathJax 数学公式渲染等。

配置页面

• Mermaid 语法支持: 启用后，可以在文章中使用 Mermaid 语法绘制图表。
• MathJax 数学公式渲染: 启用后，可以在文章中使用 MathJax 渲染数学公式。
• 图片延迟加载: 启用后，图片将采用延迟加载技术，提升页面加载速度。

报告问题

如果在安装或使用过程中遇到问题，可以在 GitHub 仓库的 "Issues" 页面提交问题。

通过以上步骤，你就可以成功安装并配置 Typecho Markdown 插件，享受 Markdown 带来的便捷和高效。

typecho-markdown A markdown parse plugin for typecho. 项目地址: https://gitcode.com/gh_mirrors/ty/typecho-markdown