pk/markdownify-bundle

此包已被废弃,不再维护。未建议替代包。

Symfony2 扩展包,将 Markdownify 类集成为一个服务

安装次数: 110,924

依赖项: 0

建议者: 1

安全性: 0

星标: 3

关注者: 1

分支: 2

开放问题: 0

类型:symfony-bundle

v4.1.0 2019-05-15 07:59 UTC

This package is auto-updated.

Last update: 2019-11-13 08:22:37 UTC


README

当 Symfony 在 2 版本(以及后来的 3 版本)时,这个扩展包比现在更有意义。随着 Symfony 4 的引入,扩展包变得越来越不重要。此外,这个扩展包主要添加了一个服务,你可以在 Symfony 应用程序中轻松配置。你不需要扩展包来做到这一点。

出于这些原因,项目已被弃用,并将不久后存档。如果你正在使用它,请考虑移除它并按如下方式配置服务

services:
  markdownify:
    class: Markdownify\ConverterExtra
    arguments: [] # optionally specify some arguments    

原始 README

为 Markdownify/Markdownify_Extra 脚本提供 Symfony 集成。

原始的 Markdownify 由 Milian Wolff 实现,后来由我自己(见 修改)和 Pixel418 进行重构。

后者现在已合并回此扩展包作为依赖项,因此该仓库中的持续开发也将可用于此扩展包。

要求

此扩展包适用于 Symfony 2.7 及以上版本。它应该能在旧版本上运行,但它们不受支持。

安装

php composer.phar require "pk/markdownify-bundle:^4.0"

AppKernel.php

将以下内容添加到 app/AppKernel.php

new PK\MarkdownifyBundle\PKMarkdownifyBundle()

配置

配置是可选的,因为所有选项都有默认值。

pk_markdownify:
  # Where to put the link references:
  # * 0 for after the content (default)
  # * 1 for after each paragraph
  # * 2 for in the paragraph, directly after the link text
  link_position: 0

  # When larger than the minimal width (25), the body will be
  # wrapped to this width. Set to false to disable wrapping (default)
  body_width: false

  # Whether to keep html tags which cannot be converted to markdown
  keep_html: false

使用

此扩展包注册了一个 markdownify 服务。像使用 Markdownify 类一样使用它

$converter = $container->get('markdownify');
$converter->parseString('<h1>Heading</h1>');
// Returns: # Heading

注意:在 3.0 版本之前,Markdownify 类包含在此扩展包中,其命名空间与当前使用的 \Markdownify 命名空间不同。如果你在代码中使用了此命名空间,升级到 3.0 时请务必更新它们。

修改

以下修改已应用于原始 Markdownify 代码。

  • PSR 0 到 2 编码标准修复
  • 组织属性和方法(属性首先,然后是方法)

许可

MIT 许可证 (MIT)。请参阅 许可文件 获取更多信息。

致谢