ceus-media/markdown

0.1.2 2021-01-31 06:55 UTC

This package is auto-updated.

Last update: 2024-09-04 00:10:33 UTC


README

用于使用多个Markdown转换器的抽象层,大部分用PHP编写。

描述

使用案例

允许将Markdown转换为其他格式(目前仅限HTML)。在此库中,这个过程将使用Renderer完成,因为Markdown代码将被渲染为其他格式。由于存在多种Markdown变体和实现,此库提供抽象层以轻松切换变体。

允许将其他格式(目前仅限HTML)转换为Markdown。在此库中,这个过程将使用Parser完成,因为其他格式将被解析为Markdown。

目标

此库的目标是提供将Markdown转换为其他格式以及从其他格式转换为Markdown的现有实现的抽象层。这将通过维护开源包列表并使用composer轻松提供此集合来实现。

安装

使用composer

composer require ceus-media/markdown

用法

在加载库或使用自动加载后,例如使用composer,您可以使用以下方式使用此库。

渲染

要将Markdown代码渲染为HTML,请使用Commonmark语法的PHP实现

use \CeusMedia\Markdown\Renderer\Html;

$renderer	= new Html();
//$renderer->setRenderer( Html::RENDERER_PARSEDOWN );
$html		= $renderer->convert( "## Heading 2" );

您可以根据需要更改使用的渲染器,例如,要支持表格和分隔代码,请切换到Parsedown

$renderer->setRenderer( Html::RENDERER_PARSEDOWN );

解析

尝试将HTML转换为Markdown可以这样做

use \CeusMedia\Markdown\Parser\Html;

$parser		= new Html();
$markdown	= $parser->convert( "<h2>Heading</h2>" );

展望

下一个版本将包括其他输出格式(如PDF或Open Document)和其他输入格式(如DokuWiki和其他Wiki语法)。

待办事项

添加DokuWiki解析器