Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/frederisk/wikitext-vscode-extension

A Visual Studio Code Extension that provides language support for Wikitext.
https://github.com/frederisk/wikitext-vscode-extension

language-support mediawiki snippets visual-studio-code visual-studio-code-extension vscode vscode-extension wikitext wikitext-markup-language

Last synced: 1 day ago
JSON representation

A Visual Studio Code Extension that provides language support for Wikitext.

Awesome Lists containing this project

README 

        

# Wikitext Markup Language Support Extension for Visual Studio Code



[![VSMarket: wikitext extension](https://vsmarketplacebadges.dev/version-short/rowewilsonfrederiskholme.wikitext.webp?color=blueviolet&logo=visual-studio-code&style=?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=RoweWilsonFrederiskHolme.wikitext)

[![Open VSX: wikitext extension](https://img.shields.io/open-vsx/v/RoweWilsonFrederiskHolme/Wikitext?color=purple&label=Open%20VSX)](https://open-vsx.org/extension/RoweWilsonFrederiskHolme/wikitext)

[![GitHub: wikitext extension](https://img.shields.io/badge/GitHub-wikitext-lightgray)](https://github.com/Frederisk/Wikitext-VSCode-Extension)

[![Toolhub: wikitext extension](https://img.shields.io/badge/Toolhub-wikitext_extension-36C)](https://toolhub.wikimedia.org/tools/wikitext-vscode-extension)



[![Build](https://github.com/Frederisk/Wikitext-VSCode-Extension/actions/workflows/build-test.yaml/badge.svg)](https://github.com/Frederisk/Wikitext-VSCode-Extension/actions/workflows/build-test.yaml)

[![GitHub Actions CodeQL](https://github.com/Frederisk/Wikitext-VSCode-Extension/actions/workflows/codeql-analysis.yml/badge.svg/)](https://github.com/Frederisk/Wikitext-VSCode-Extension/actions?query=workflow%3ACodeQL)

[![CodeFactor Status](https://www.codefactor.io/repository/github/frederisk/wikitext-vscode-extension/badge)](https://www.codefactor.io/repository/github/frederisk/wikitext-vscode-extension)



[![@mastodon.social@rwfholme](https://img.shields.io/badge/mastodon.social-%40rwfholme-66F)](https://mastodon.social/@rwfholme)

[![Patreon Donate](https://img.shields.io/badge/donate-patreon-orange)](https://www.patreon.com/rwfholme)



This Visual Studio Code Extension provides support of Wikitext Markup language. With this extension, you can more easily discover your grammatical problems through the marked and styled text. The plugin is based on MediaWiki's Wikitext standard, but the rules are somewhat stricter, which helps users write text that is easier to read and maintain.



Of course, the development of this extension is short, and there may be some errors in operation and labeling. If you find a problem, please report it to me immediately for resolution.



If you get help with this project, give this project a star or recommend it to others, thanks!😸



## Enhancement Tool: [Wikitext-Extension-Gadget](https://github.com/Frederisk/Wikitext-Extension-Gadget)



- Now you can add [Wikitext Extension Gadget](https://github.com/Frederisk/Wikitext-Extension-Gadget) as a user gadget on your wiki site. And you will get a button to open VSCode directly in your browser to edit the page!



    Go to the gadget's repository page to learn more.



    Wikitext Extension Gadget



## Features



- Color and style annotations of Wikitext can make it easier for users to intuitively find problems in writing grammatical formats.



    Code main page



- Automatic matching and closing of simple parentheses reduces unnecessary double typing.



    Code video



- The special comment syntax\(``&``\) can folds the code for easy reading.



    Code region



- Press `Ctrl + Shift + V` or click the Preview icon in the title menu bar directly in the Wikitext content to get a parsed preview of Wikitext in the currently active text editor.



    Code previewer



- Enter `@[name]` to get a snippet of wikitext. Such as `@table`, `@region`, `@title`...



    Code snippets



- You can modify the website content by logging in directly in VSCode! Enter the settings page, search Wikitext and find the username and password items, and fill in them. Then press `F1` in the text editor, select `Post your page to the website`!



- Obtain the Wikitext source code directly in VSCode according to the page name without opening the web page. Press `F1` and select `Pull page to edit` to use this function.



- Browse the page by entering the page name. Press `F1` then select `View the page`.



## Release Notes



- When getting the page preview, the API request will refer to `PageTitle` and `ContentModel` in the `PAGE_INFO` part.



## Usage



### Usage Requirements



Please ensure that your VSCode version is higher than 1.64.0, this version requirements may change in the future.



Generally, make sure that your VSCode is always the latest version.



## Development



### Development Requirements



- [Node.js](https://nodejs.org) (with npm) at least v16.



### How to build this extension yourself



Firstly, clone this repository and change directory to the repository, then install VS Code Extension Manager and other packages:



```bash

npm install -g yarn vsce # VS Code Extension Manager

yarn install # Install devDependencies

```



Package this project and you will get a `.vsix` file:



```bash

vsce package --yarn # Package Extension with yarn

```



This is it!



## Special Thanks



- [caltaojihun](https://github.com/caltaojihun)

- [Jason Williams](https://github.com/jasonwilliams)

- [quicktype](https://github.com/quicktype)

- [dj radon](https://github.com/djradon)