Home

• 简介
• 其他版本
  • Mini
  • Browser
• 安装方法
  • Node.js
  • 浏览器
• 使用方法

简介

wikiparser-node 是一款由 Bhsd 开发的基于 Node.js 环境的离线维基文本语法解析器，可以解析绝大部分的维基语法并生成语法树，还可以很方便地对语法树进行查询和修改，最后返回修改后的维基文本。语法树的每个节点对应一个仿照 HTMLElement 类设计的类 Token。本 Wiki 将依次介绍不同维基语法对应的各类 Token 可用的属性和方法。

其他版本

Mini

仅保留了解析功能和语法错误分析功能的轻量版本，解析生成的语法树不能修改。这个版本被应用于 eslint-plugin-wikitext 插件。

Browser

兼容浏览器的版本，可用于代码高亮或是搭配 CodeMirror5 编辑器作为语法分析插件。（使用实例展示）

安装方法

Node.js

请根据需要需要安装对应的版本（latest 或 mini），如：

npm i wikiparser-node # 默认为latest

或

npm i wikiparser-node@mini

浏览器

可以通过 CDN 下载代码，如：

<script src="//cdn.jsdelivr.net/npm/wikiparser-node@browser/bundle/bundle.min.js"></script>

或

<script src="//unpkg.com/wikiparser-node@browser/bundle/bundle.min.js"></script>

更多浏览器端可用的插件请查阅对应文档。

使用方法

请查阅主入口文档和各类 Token 对应的文档。