jelix/wikirenderer

WikiRenderer 是一个库,可以将维基内容转换为 HTML 或其他格式。

4.0.0-beta1 2014-12-02 09:15 UTC

This package is auto-updated.

Last update: 2024-08-28 21:38:49 UTC


README

WikiRenderer 4 是一个库,可以将维基内容转换为其他格式,如 HTML、Docbook 或其他维基语法。

警告:由于我们正在重构许多内容,master 分支目前不稳定。请前往 3.x 分支以获取稳定版本。WikiRenderer 4 的文档和网站尚未更新。

WikiRenderer 4.0-pre 支持以下标记

  • Dokuwiki 语法
  • Trac 语法
  • WR3(WikiRenderer 3.0 的特定标记)
  • ClassicWR(WikiRenderer 1.0 的特定标记)

并且它可以生成 HTML、Docbook 或清理后的文本。

在最终版本中,计划支持 Markdown 标记和 Markdown 生成器。

安装

您可以通过 Composer 安装它。请参阅 Packagist.org 上的页面

快速示例

// first choose a Markup, by instancying its configuration object
// here we want to parse DokuWiki syntax
$markupConfig = new \WikiRenderer\Markup\DokuWiki\Config();

// then choose a generator, e.g., the object which generates
// the result text in the expected format. Here, HTML...
$genConfig = new \WikiRenderer\Generator\Html\Config();
$generator = new \WikiRenderer\Generator\Html\Document($genConfig);

// now instancy the WikiRenderer engine
$wr = new \WikiRenderer\Renderer($generator, $markupConfig);

// call render() method: it will parse DokuWiki syntax, and will
// generate HTML content
$html = $wr->render($awikitext);

注意:这是一个新 API,它可能直到 4.0 版本发布前都会发生变化。

文档和网站

英文和法语文档在 http://wikirenderer.jelix.org

文档尚未更新,并讨论了 WikiRenderer 3,它与 WikiRenderer 4 不兼容。欢迎帮助更新文档和网站 ;-)