paveld/markdown-wiki

用于将 Markdown 解析为 Wiki 文本库 cebe/markdown 的扩展

维护者

详细信息

github.com/PavelD/markdown-wiki

主页

源代码

问题

安装: 31

依赖项: 1

建议: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

开放问题: 1

v0.3.1 2022-01-25 01:05 UTC

Requires

Requires (Dev)

MIT bbba16e7a83f8d03e5beff2091946376db098f83

  • Pavel Dobes <konference.woop@lnx.cz>

markdownwiki

This package is auto-updated.

Last update: 2024-09-26 07:09:51 UTC

README

关于

Cebe 的 Markdown 库 Cebe 的扩展，用于将 Mrkdown 解析为 WikiText 语法。

它作为 MediaWiki MarkdownWiki 解析器的后端库使用。

特点

解析器渲染链接和表格为 Wiki 格式。

支持的元素

行内元素

  • 粗体
  • 斜体
  • 代码高亮
  • 链接
  • 图片

块级元素

  • 引用块
  • 标题
  • 水平线
  • 有序列表和无序列表
  • 段落
  • 预格式化文本
  • 表格

额外结构

模板

示例

---
template: temaplate name
myparam1: content of my param1
myparam2: content of my param2
---

前两行是必须的。其他行是可选的。代码检查 : 是否存在。

解析结束在模板的末尾或第一个空行上。

魔法词

MediaWiki 解析器的双下划线 行为开关 与 Markdown 粗体文本的格式相同。为了避免这些问题，引入了新的格式。

使用 {{__NOTOC__}} 代替简单的 __NOTOC__。markdown-wiki 解析器会删除大括号，并在 Wiki 解析时应用魔法词。

安装

安装遵循原始 Cebe 的 Markdown 库的建议。

建议通过 composer) 运行来执行安装

composer require paveld/markdown-wiki "*"

然后

composer update paveld/markdown-wiki

配置

如果您不需要解析某些元素，可以通过以下指令移除解析。

$m = new MarkdownWiki();\
$m->disableParsingRule('headline');
$wikTextb = $m->parse($MarkdownText);

disableParsingRule() 方法的可能参数列表

一些元素由多个规则识别。

块级元素

  • 代码块 由 code 和 fencedcode 识别
  • 标题 由 headline 识别
  • 水平线 由 ahr 和 hr 识别
  • HTML 元素 由 html 识别
  • Markdown 表格 由 table 识别
  • 有序列表 由 ol 识别
  • 引用块 由 quote 识别
  • 模板 由 aaatemplate 和 template 识别
  • 无序列表 由 bul 和 ul 识别

行内元素

  • 转义 由 parseEscape 识别
  • 大于号 由 parseGt 识别
  • HTML 实体 由 parseEntity 识别
  • 图片 由 parseImage 识别
  • 内联代码 由 parseInlineCode 识别
  • 链接 由 parseLink 识别
  • 魔法词 由 parseMagicWord 识别
  • 特殊属性 由 parseSpecialAttributes 识别
  • 粗体和斜体 由 parseEmphStrong 识别

许可证

MIT