paveld/mw-markdown-wiki

MediaWiki 页面中支持 Markdown 的扩展

安装: 28

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

公开问题: 2

类型:mediawiki-extension

v0.3.2 2022-01-24 23:33 UTC

This package is auto-updated.

Last update: 2024-09-25 05:01:33 UTC


README

关于

此扩展允许在 wiki 页面上使用 Markdown 语法。它基于 Cebe 的 Markdown 库的扩展,用于将 Mrkdown 解析为 WikiText 语法。

为什么需要新的扩展

我过去有很多 Markdown 文件,这些文件曾经是我们个人网站的数据来源。但是提供商已经不存在了,我在磁盘上有很多文件,里面包含一些不太为人知的 Markdown 变体。

Blake's Markdown。它在我的 MediaWiki 版本上无法工作,修复它变成了这个项目。为了在解析上更加灵活,我将后端库切换到了 Cebe's Markdown 解析器。此外,我还将这些文件中注入了一些 wiki 语法,并改变了解析的逻辑。

现在可以将 Markdown 语言与 wiki 语法结合起来。

为了简化扩展,我将 MarkdownWiki 解析器提取到了一个独立的项目中。

安装

  • $mw 中运行 COMPOSER=composer.local.json composer require --no-update paveld/mw-markdown-wiki,其中 $mw 是您的 MediaWiki 安装路径
  • $mw 中运行 composer update paveld/mw-markdown-wiki --no-dev -o
  • 将以下内容添加到 $mw/LocalSettings.php
wfLoadExtension( 'MarkdownWiki' );

将 MarkdownWiki 设置为默认解析器,并将以下代码添加到文件中

$wgMarkdownWikiDefaultOn = true;

使用方法

要允许文章中使用 Markdown 语法,请将 {{MARKDOWN}} 放在页面开头。

要在每个页面上使用 Markdown,请使用 $wgMarkdownWikiDefaultOn$mw/LocalSettings.php

自定义 Markdown 元素

请参阅 MarkdownWiki 项目页面上的 README.md