PHP Markdown Extra Extended 技术文档

1. 安装指南

环境要求

• PHP 5.3 或更高版本

安装步骤

1. 下载项目文件：

   • 从 GitHub 仓库下载项目文件，或者使用 git clone 命令克隆仓库。

2. 将项目文件放置在您的项目目录中：

   • 将 markdown.php 和 markdown_extended.php 文件放置在您的 PHP 项目目录中。

3. 包含文件：

   • 在您的 PHP 脚本中包含 markdown_extended.php 文件：

     require_once('markdown_extended.php');
     

2. 项目的使用说明

基本用法

使用 MarkdownExtended 函数将 Markdown 格式的文本转换为 HTML。

$markdown = "## 这是一个标题\n\n这是一个段落。";
$html = MarkdownExtended($markdown);
echo $html;

新增语法

1. 换行符生成 <br />：

   • 在行尾直接按回车即可生成 <br /> 标签，无需添加两个或更多空格。

2. 引用块的 cite 属性支持：

   • 使用以下语法为引用块添加 cite 属性：

     > (http://www.example.com) 引用内容...
     

3. 代码块的语言支持：

   • 使用 ~~~ 或 ```` 标记代码块，并指定语言类型：

     ~~~php
     echo "Hello, World!";
     ~~~
     

4. figure 和 figcaption 标签支持：

   • 使用 === 包裹内容创建 figure 标签，并使用 [ 和 ] 添加可选的 figcaption：

     === [这是一个图例]
     ![](img/example.png)
     ===
     

3. 项目API使用文档

MarkdownExtended($text)

• 参数：
  • $text：需要转换的 Markdown 格式文本。
• 返回值：
  • 返回转换后的 HTML 格式文本。

示例

$markdown = "## 这是一个标题\n\n这是一个段落。";
$html = MarkdownExtended($markdown);
echo $html;

4. 项目安装方式

手动安装

1. 下载项目文件并放置在您的项目目录中。
2. 在您的 PHP 脚本中包含 markdown_extended.php 文件：

   require_once('markdown_extended.php');
   

使用 Composer 安装

1. 在 composer.json 文件中添加依赖：

   {
       "require": {
           "your-vendor-name/php-markdown-extra-extended": "dev-master"
       }
   }
   

2. 运行 composer install 命令安装依赖。
3. 在您的 PHP 脚本中包含自动加载文件：

   require 'vendor/autoload.php';
   

通过以上步骤，您可以成功安装并使用 PHP Markdown Extra Extended 项目。