README

是Parsedown/ParsedownExtra的扩展。

功能

自动生成目录
1. 在文本中指定目录标签，ParsedownPlus将插入自动生成的目录。
支持LaTeX格式的数学表达式
1. ParsedownPlus识别 $ ... $ 或$$ ... $$作为类似LaTeX的公式，并在Markdown文本中不进行解析。
2. $ ... $ 是内联的，而$$ ... $$是块状的。
识别带围栏代码中的文件名
1. ParsedownPlus识别```lang:file ... ```并将文件名设置为<code>标签的data-filename属性。

用法

使用composer

当使用composer时，请切换到您的项目文件夹并输入以下命令。

composer require izadori/parsedown-plus

如果找不到Parsedown，它将安装Parsedown。如果您使用ParsedownExtra，您可能需要手动安装它。

composer require erusev/parsedown-extra

您必须引入autoload.php才能在您的项目中使用ParsedownPlus。

require_once __DIR__ . "/vender/autoload.php";

use \Izadori\ParsedownPlus\ParsedownPlus;

$parser = new ParsedownPlus();

$text = <<<EOF
# Equation of _Circle_

$ x_{1}^{2} + x_{2}^{2} = 1 $
EOF;

$line = "It's **inline** text!";

// parses Markdown text
echo $parser->text($text); // prints: <h1>Equation of <em>Circle</em></h1> <p>$  x_{1}^{2} + x_{2}^{2} = 1  $</p>
// parses inline text
echo $parser->line($line); // prints: It's <strong>inline</strong> text!

不使用composer

如果不使用composer，您可以从这里下载ParsedownPlus到您的项目中。

要使用ParsedownPlus，您需要引入Parsedown.php。如果您需要，还需要引入ParsedownExtra.php。然后，引入ParsedownPlus.php；

require_once __DIR__ . "/Parsedown.php";
require_once __DIR__ . "/ParsedownExtra.php"; // if you need
require_once __DIR__ . "/ParsedownPlus.php";

use /Izadori;

$parser = new ParsedownPlus();

$text = <<<EOF
# Equation of _Circle_

$ x_{1}^{2} + x_{2}^{2} = 1 $
EOF;

$line = "It's **inline** text!";

// parses Markdown text
echo $parser->text($text); // prints: <h1>Equation of <em>Circle</em></h1> <p>$  x_{1}^{2} + x_{2}^{2} = 1  $</p>
// parses inline text
echo $parser->line($line); // prints: It's <strong>inline</strong> text!

选项

ParsedownPlus有一些公开变量作为其选项。

关于自动生成目录

由ParsedownPlus生成的目录是一个类似有序列表的。

<ol>
  <li>Heading 1</li>
  <li>Heading 2</li>
    <ol>
      <li>Heading 2.1</li>
      <li>Heading 2.2</li>
    </ol>
  <li>Heading 3</li>
</ol>

关于错误和报告

如果您发现错误，请向Github发送一个问题，包括错误的性质和发生错误的Markdown文本。

关于许可证

ParsedownPlus符合MIT许可证。有关详细信息，请参阅LICENSE文件。

关于作者

Izadori

历史记录

ParsedownPlus.php

2021.09.02 [ver.1.0.0]
- 发布在Github上
2021.09.02 [ver.1.0.1]
- 修复了一个阻止ParsedownExtra正常工作的错误。
- 添加了使用语言名称类的前缀在带围栏代码中的功能。
2021.11.28 [ver.1.0.2]
- 修改为在块数学公式中输出的<p>标签中添加class="block-math"。

本文件

2021.09.02
- 添加了与ParsedownPlus ver.1.0.1匹配的描述。
- 发布在Github上
2021.09.06
- 修改示例代码。

izadori / parsedown-plus

维护者

详细信息