odino/php-markdown-extra-extended

PHP Markdown & Extra

0.1.0 2013-03-14 14:30 UTC

This package is not auto-updated.

Last update: 2024-09-10 05:11:34 UTC


README

PHP Markdown (Extra) 项目(PME)的一个分支,增加了额外的语法,尤其专注于为输出 HTML 添加更多 HTML 属性支持,并输出 HTML5。

从 PHP Markdown (Extra) 语法的变化

除非明确指定,现有的 Markdown 标记仍然按原来的方式工作。原始语法在此处文档化

换行生成 <br />

在 PME 中,当你想使用 Markdown 插入 <br /> 换行标签时,你只需要在行尾输入回车即可。这在我的一些项目中比之前使用两个或更多空格然后回车的方法更方便。这也是 Markdown 与 GFM 的工作方式。

两个回车不会插入 <br />,而是像通常一样创建一个新段落。

支持块引用上的 cite 属性

现在可以在 blockquote 元素上添加可选的 cite 属性。

新的、可选的语法是

> (cite url) Cited content follows ...

示例

> (http://www.whatwg.org/) Content inside a blockquote must be quoted 
> from another source, whose address, if it has one, 
> may be cited in the `cite` attribute.

将生成以下 HTML

<blockquote cite="http://www.whatwg.org/">
<p>Content inside a blockquote must be quoted 
from another source, whose address, if it has one, 
may be cited in the `cite` attribute.</p>
</blockquote>

从 PME 的重大变更

现有的块引用规则和 格式选项 仍然适用。这个添加有一个小的重大变更。如果你的引用以 "(" 开始,你需要在初始的 ">" 和 "(" 之间至少有两个空格。例如:

>  (Ut brisket flank salami.) Cow cupidatat ex t-bone sirloin id. 
> Sunt flank pastrami spare ribs sint id, nulla nisi.

将生成以下 HTML

<blockquote>
  <p>(Ut brisket flank salami.) Cow cupidatat ex t-bone sirloin id.<br>
  Sunt flank pastrami spare ribs sint id, nulla nisi.</p>
</blockquote>

支持带有语言支持的围栏代码块和交替围栏标记(```)

现在可以指定代码块的编程语言类型,并使用交替围栏标记(```),使其语法与 GFM 相同。

此添加遵循 W3C 的 建议方法 指定语言。

示例

~~~html
<p>Ut brisket flank salami.  Cow cupidatat ex t-bone sirloin id.</p>
~~~

使用替代围栏标记

```html
<p>Ut brisket flank salami.  Cow cupidatat ex t-bone sirloin id.</p>
```

两者都将输出以下 HTML

<pre><code class="language-html">
<p>Ut brisket flank salami.  Cow cupidatat ex t-bone sirloin id.</p>
</code></pre>

支持 figurefigcaption 标签

现在实验性地支持 HTML5 标签 figurefigcaption

figure 是一个块级元素,通过将一些其他内容用三个或更多等于号(=)包裹来创建。

可选的 figure caption 可以添加到图例的顶部或底部,紧随等于号之后,用方括号 [] 包裹。

示例

此示例显示没有标题的 figure

===
![](img/reference.png)
===

此示例显示在内容之前添加标题的 figure

=== [A **happy face** is good for web developers]
![](img/reference.png)
===

此示例显示在内容之后添加标题的 figure

===
![](img/reference.png)
=== [A **happy face** is good for web developers]

用法

你需要同时包含 markdown.phpmarkdown_extended.php 文件,但只需要包含 markdown_extended.php

require_once('markdown_extended.php');

// Convert markdown formatted text in $markdown to HTML
$html = MarkdownExtended($markdown);

许可

PHP Markdown Extra Extended 在 MIT 许可证 下授权。有关详细信息,请参阅 LICENSE 文件。