prism-wiki
v1.0.1
Published
A Prism gadget for MediaWiki sites
Maintainers
Readme
Prism-Wiki
Prism-Wiki 是由 Bhsd 编写的一款用于 MediaWiki 站点的代码块高亮小工具,主要基于 Prism,并使用 WikiParser-Node 改进对维基文本的高亮模式。
Prism-Wiki 也能用于在非 MediaWiki 的浏览器或 Node.js 环境下改进 Prism 对维基文本的高亮支持,详见 Node.js 用法。使用案例可以参考 WikiParser-Node 渲染的 <syntaxhighlight> 标签。
MediaWiki 站点小工具
使用方法
在个人 JS 页添加以下代码:
mw.loader.load('//cdn.jsdelivr.net/npm/prism-wiki');或
mw.loader.load('//unpkg.com/prism-wiki/dist/main.min.js');所有指定了语言的代码块都会被自动高亮,未指定语言的代码块可以双击后手动输入语言并高亮。
设置
根据需要在加载小工具之前添加以下代码:
window.Prism = window.Prism || {};
Prism.theme = ''; // 主题,可省略
Prism.pluginPaths = []; // 插件相对路径,可省略主题
所有可用的 Prism 主题都可以在这里找到。
插件相对路径
所有可用的 Prism 插件都可以在这里找到。插件路径需相对于 plugins/ 填写,注意有些插件同时包含了 JavaScript 和 CSS 文件,例如加载 autolinker 插件:
Prism.pluginPaths = [
'autolinker/prism-autolinker.min.js',
'autolinker/prism-autolinker.min.css',
];小工具总是加载 line-numbers、show-language、copy-to-clipboard 和 inline-color 插件,不需要手动添加。
Node.js 用法
安装
npm install prismjs wikilint # peer dependencies
npm install prism-wiki示例
const Prism = require('prismjs'),
Parser = require('wikilint'),
registerWiki = require('prism-wiki').default;
registerWiki(Prism, Parser);
Prism.highlight('[[Foo]]', Prism.languages.wiki, 'wiki');