league/commonmark-extras

此包已被废弃且不再维护。作者建议使用league/commonmark包。

league/commonmark Markdown 解析器的自定义扩展

赞助包维护!
colinodell
Patreon

安装次数: 79,748

依赖项: 7

建议者: 0

安全: 0

星标: 30

关注者: 4

分支: 5

开放问题: 0

类型:commonmark-extension

1.2.0 2020-04-04 16:03 UTC

README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

已弃用

此扩展已被弃用。现在所有功能都存在于 league/commonmark 1.3+ 中。您可以选择单独注册各种扩展,或者使用 GithubFlavoredMarkdownExtension 来获得完整的 GFM 功能,因此您应该升级到该版本的 league/commonmark 并使用它而不是这个。

概述

league/commonmark-extras 是一个用于 league/commonmark 项目的有用 GFM 扩展和实用工具的集合。

将此扩展添加到您的项目将自动注册以下子扩展

扩展 目的
league/commonmark-ext-autolink 自动将 URL 和电子邮件地址创建为链接(无需使用 <...> 语法)
league/commonmark-ext-smartpunct 智能地将 ASCII 引号、破折号和省略号转换为它们的 Unicode 等效项
league/commonmark-ext-strikethrough 添加对 ~~删除线~~ 语法的支持
league/commonmark-ext-table GFM 风格的表格
league/commonmark-ext-task-list GFM 风格的任务列表 - [x] 如此

安装

通过 Composer

$ composer require league/commonmark-extras

使用方法

这可以添加到任何新的 环境

use League\CommonMark\CommonMarkConverter;
use League\CommonMark\Environment;
use League\CommonMark\Extras\CommonMarkExtrasExtension;

// Obtain a pre-configured Environment with all the CommonMark parsers/renderers ready-to-go
$environment = Environment::createCommonMarkEnvironment();

// REGISTER THIS EXTENSION HERE
$environment->addExtension(new CommonMarkExtrasExtension());

// Define your configuration:
$config = [];

// Now that the `Environment` is configured we can create the converter engine:
$converter = new CommonMarkConverter($config, $environment);

// Go forth and convert you some Markdown!
echo $converter->convertToHtml('# Hello World!');

变更日志

有关最近更改的更多信息,请参阅变更日志

测试

$ composer test

安全

如果您发现任何安全相关的问题,请通过电子邮件发送至 colinodell@gmail.com 而不是使用问题跟踪器。

致谢

许可

此库采用 BSD-3 许可。有关更多信息,请参阅 LICENSE 文件