https://github.com/bhsd-harry/prism-wiki

A Prism gadget for MediaWiki sites
https://github.com/bhsd-harry/prism-wiki

mediawiki mediawiki-gadget prismjs wikitext

Last synced: 29 days ago
JSON representation

A Prism gadget for MediaWiki sites

• Host: GitHub
• URL: https://github.com/bhsd-harry/prism-wiki
• Owner: bhsd-harry
• License: gpl-3.0
• Created: 2024-03-21T14:58:41.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-15T23:56:45.000Z (about 2 months ago)
• Last Synced: 2025-04-16T00:37:35.124Z (about 2 months ago)
• Topics: mediawiki, mediawiki-gadget, prismjs, wikitext
• Language: TypeScript
• Homepage:
• Size: 230 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Prism-Wiki

[![npm version](https://badge.fury.io/js/prism-wiki.svg)](https://www.npmjs.com/package/prism-wiki)

[![CodeQL](https://github.com/bhsd-harry/prism-wiki/actions/workflows/codeql.yml/badge.svg)](https://github.com/bhsd-harry/prism-wiki/actions/workflows/github-code-scanning/codeql)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/6e3f4c7dd6a94c1cb384aa929b899f5c)](https://app.codacy.com/gh/bhsd-harry/prism-wiki/dashboard)

**Prism-Wiki** 是由 Bhsd 编写的一款用于 MediaWiki 站点的代码块高亮小工具，主要基于 [Prism](https://prismjs.com/)，并使用 [WikiParser-Node](https://github.com/bhsd-harry/wikiparser-node) 改进对[维基文本](https://www.mediawiki.org/wiki/Wikitext)的高亮模式。

## 使用方法

在*个人 JS 页*添加以下代码：

```js

mw.loader.load('//cdn.jsdelivr.net/npm/prism-wiki');

```

或

```js

mw.loader.load('//unpkg.com/prism-wiki');

```

所有指定了语言的代码块都会被自动高亮，未指定语言的代码块可以双击后手动输入语言并高亮。

## 设置

根据需要在加载小工具之前添加以下代码：

```js

window.Prism = window.Prism || {};

Prism.theme = ''; // 主题，可省略

Prism.pluginPaths = []; // 插件相对路径，可省略

```

### 主题

所有可用的 Prism 主题都可以在[这里](https://prismjs.com/examples)找到。

### 插件相对路径

所有可用的 Prism 插件都可以在[这里](https://github.com/PrismJS/prism/tree/master/plugins)找到。插件路径需相对于 `plugins/` 填写，注意有些插件同时包含了 JavaScript 和 CSS 文件，例如加载 `autolinker` 插件：

```js

Prism.pluginPaths = [

	'autolinker/prism-autolinker.min.js',

	'autolinker/prism-autolinker.min.css',

];

```

总是加载 `line-numbers`、`show-language`、`copy-to-clipboard` 和 `inline-color` 插件。

[GNU General Public License 3.0](https://www.gnu.org/licenses/gpl-3.0-standalone.html)