Typecho Markdown 插件使用教程

Typecho Markdown 插件使用教程

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

1、项目的目录结构及介绍

Typecho Markdown 插件的目录结构如下：

typecho-markdown/
├── LICENSE
├── README.md
├── Plugin.php
├── MarkdownParse.php
├── composer.json
├── composer.lock
├── renovate.json
├── github/
│   └── workflows/
│       └── tests
├── markdown-parse-config-page.png
└── vendor/

目录结构介绍

• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• Plugin.php: 插件的主文件，负责插件的初始化和注册。
• MarkdownParse.php: Markdown 解析的核心文件。
• composer.json 和 composer.lock: Composer 依赖管理文件。
• renovate.json: Renovate 配置文件，用于自动化依赖更新。
• github/workflows/tests: GitHub Actions 的工作流文件，用于自动化测试。
• markdown-parse-config-page.png: 配置页面的截图。
• vendor/: Composer 自动生成的依赖库目录。

2、项目的启动文件介绍

项目的启动文件是 Plugin.php。这个文件负责插件的初始化和注册。以下是 Plugin.php 的主要内容：

<?php
if (!defined('__TYPECHO_ROOT_DIR__')) exit;

class MarkdownParse_Plugin implements Typecho_Plugin_Interface
{
    public static function activate()
    {
        // 插件激活时的操作
    }

    public static function deactivate()
    {
        // 插件禁用时的操作
    }

    public static function config(Typecho_Widget_Helper_Form $form)
    {
        // 插件配置页面
    }

    public static function personalConfig(Typecho_Widget_Helper_Form $form)
    {
        // 个人配置页面
    }

    public static function render()
    {
        // 渲染 Markdown 内容
    }
}

启动文件介绍

• activate(): 插件激活时的操作。
• deactivate(): 插件禁用时的操作。
• config(): 插件配置页面的生成。
• personalConfig(): 个人配置页面的生成。
• render(): 渲染 Markdown 内容。

3、项目的配置文件介绍

项目的配置文件主要是 composer.json 和 renovate.json。

composer.json

composer.json 文件定义了项目的依赖和一些元数据。以下是 composer.json 的主要内容：

{
    "name": "mrgeneralgoo/typecho-markdown",
    "description": "A markdown parse plugin for typecho",
    "type": "typecho-plugin",
    "require": {
        "league/commonmark": "^1.6"
    },
    "license": "MIT",
    "authors": [
        {
            "name": "mrgeneralgoo",
            "email": "mrgeneralgoo@gmail.com"
        }
    ],
    "minimum-stability": "stable"
}

renovate.json

renovate.json 文件用于配置 Renovate，自动化依赖更新。以下是 renovate.json 的主要内容：

{
    "extends": [
        "config:base"
    ],
    "schedule": [
        "before 3am on Monday"
    ]
}

配置文件介绍

• composer.json: 定义了项目的依赖和元数据，如项目名称、描述、许可证、作者信息等。
• renovate.json: 配置 Renovate 自动化依赖更新的时间和规则。

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