Home (EN)

• Introduction
• Other Versions
  • Mini
  • Browser-compatible
• Installation
  • Node.js
  • Browser
• Usage
• Tests

Other Languages

• 简体中文

Introduction

WikiParser-Node is an offline Wikitext parser developed by Bhsd for the Node.js environment. It can parse almost all wiki syntax and generate an Abstract Syntax Tree (AST). It also allows for easy querying and modification of the AST, and returns the modified wikitext.

Each node of the AST corresponds to a class Token modeled after the HTMLElement class. This Wiki will introduce the properties and methods available for each type of Token corresponding to different wiki syntax.

Other Versions

Mini

See WikiLint. This version provides a CLI, but only retains the parsing functionality and linting functionality. The parsed AST cannot be modified. It is used in the eslint-plugin-wikitext plugin.

Browser-compatible

A browser-compatible version, which can be used for code highlighting or as a linting plugin in conjunction with editors such as CodeMirror and Monaco. (Usage example)

Installation

Node.js

Please install the corresponding version as needed (WikiParser-Node or WikiLint), for example:

npm i wikiparser-node

or

npm i wikilint

Browser

You can download the code via CDN, for example:

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

or

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

For more browser extensions, please refer to the corresponding documentation.

Usage

Please refer to the document of the main entry and the corresponding documents of each type of Token.

Tests

A complete test list based on the MediaWiki PHP parser is available here.