# WikiParser-Node [](https://www.npmjs.com/package/wikiparser-node) [](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/codeql.yml) [](https://github.com/bhsd-harry/wikiparser-node/actions/workflows/node.js.yml) [](https://www.npmjs.com/package/wikiparser-node) [](https://app.codacy.com/gh/bhsd-harry/wikiparser-node/dashboard)  ## Other Languages - [简体中文](./README-%28ZH%29.md) ## Introduction WikiParser-Node is an offline [Wikitext](https://www.mediawiki.org/wiki/Wikitext) parser developed by Bhsd for the [Node.js](https://nodejs.org/) environment. It can parse almost all wiki syntax and generate an [Abstract Syntax Tree (AST)](https://en.wikipedia.org/wiki/Abstract_syntax_tree) ([Try it online](https://bhsd-harry.github.io/wikiparser-node/#editor)). It also allows for easy querying and modification of the AST, and returns the modified wikitext. Although WikiParser-Node is not originally designed to convert Wikitext to HTML, it provides a limited capability to do so. [Here](https://bhsd-harry.github.io/wikiparser-website/) is a list of example HTML pages rendered using this package. ## Other Versions ### Mini (also known as [WikiLint](https://www.npmjs.com/package/wikilint)) This version provides a [CLI](https://en.wikipedia.org/wiki/Command-line_interface), but only retains the parsing functionality and linting functionality. The parsed AST cannot be modified. It powers the [Wikitext LSP](https://www.npmjs.com/package/wikitext-lsp), which provides multiple language services for editors such as [VS Code](https://marketplace.visualstudio.com/items?itemName=Bhsd.vscode-extension-wikiparser), [Sublime Text](https://lsp.sublimetext.io/language_servers/#mediawiki), and [Helix](https://github.com/helix-editor/helix/wiki/Language-Server-Configurations#wikitext). A list of available linting rules can be found [here](https://github.com/bhsd-harry/wikiparser-node/wiki/Rules). ### 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](https://www.npmjs.com/package/@bhsd/codemirror-mediawiki) and [Monaco](https://www.npmjs.com/package/monaco-wiki) ([Usage example](https://bhsd-harry.github.io/wikiparser-node)). It has been integrated into the MediaWiki official [CodeMirror extension](https://www.mediawiki.org/wiki/Extension:CodeMirror) since Release 1.45. ## Installation ### Node.js Please install the corresponding version as needed (`WikiParser-Node` or `WikiLint`), for example: ```sh npm i wikiparser-node ``` or ```sh npm i wikilint ``` ### Browser You can download the code via CDN, for example: ```html ``` or ```html ``` For more browser extensions, please refer to the corresponding [documentation](https://github.com/bhsd-harry/wikiparser-node/wiki/Browser-%28EN%29). ## Usage ### CLI usage For MediaWiki sites with the [CodeMirror extension](https://mediawiki.org/wiki/Extension:CodeMirror) installed, such as different language editions of Wikipedia and other [Wikimedia Foundation-hosted sites](https://meta.wikimedia.org/wiki/Special:SiteMatrix), you can use the following command to obtain the parser configuration: ```sh npx getParserConfig