brainsware / php-markdown-extra-extended
PHP Markdown & Extra
Requires
- php: >=5.3
This package is not auto-updated.
Last update: 2024-09-14 14:46:39 UTC
README
PHP Markdown (Extra) 项目(PME)的分支,扩展了额外的语法,特别专注于添加更多 HTML 属性以输出 HTML,以及输出 HTML5。
从 PHP Markdown (Extra) 语法的变化
除非明确指定,现有的 Markdown 标记仍然保持原有的效果。原始语法在此处有文档说明
换行生成 <br />
在 PME 中,当你想使用 Markdown 插入 <br />
换行标签时,只需在行尾输入两个或多个空格,然后按回车。在我的项目中,这比有帮助还令人烦恼,所以现在你只需要按回车。这也是 Markdown 与 GFM 一起工作的方式。
两次回车不会插入 <br />
,而是像通常一样创建一个新段落。
支持 blockquotes 上的 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 的破坏性变化
对于 blockquotes 的现有规则和格式选项仍然适用。此添加带来了一处小的破坏性变化。如果你的引用以 "(" 开头,则初始 ">" 和 "(" 之间至少需要两个空格。例如。
> (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>
支持 figure 和 figcaption 标签
现在对 HTML5 标签 figure 和 figcaption 提供了实验性支持。
figure 是一个块级元素,通过用三个或更多等于号(=)包围其他内容来创建。
可选的 figure caption 可以添加到图例的顶部或底部,紧随等于号之后,用 [ 和 ] 符号包裹。
示例
此示例显示了没有图例的 figure
===  ===
此示例显示了在内容之前添加图例的 figure
=== [A **happy face** is good for web developers]  ===
此示例显示了在内容之后添加图例的 figure
===  === [A **happy face** is good for web developers]
使用方法
你需要 markdown.php 和 markdown_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 文件。