Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 27 days ago
JSON representation
A Visual Studio Code Extension that provides language support for Wikitext.
- Host: GitHub
- URL: https://github.com/frederisk/wikitext-vscode-extension
- Owner: Frederisk
- License: mit
- Created: 2020-02-06T05:39:12.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-23T10:01:06.000Z (about 1 month ago)
- Last Synced: 2024-10-09T18:42:39.921Z (27 days ago)
- Topics: language-support, mediawiki, snippets, visual-studio-code, visual-studio-code-extension, vscode, vscode-extension, wikitext, wikitext-markup-language
- Language: TypeScript
- Homepage:
- Size: 7.47 MB
- Stars: 88
- Watchers: 5
- Forks: 14
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Wikitext Markup Language Support Extension for Visual Studio Code
[](https://marketplace.visualstudio.com/items?itemName=RoweWilsonFrederiskHolme.wikitext)
[](https://open-vsx.org/extension/RoweWilsonFrederiskHolme/wikitext)
[](https://github.com/Frederisk/Wikitext-VSCode-Extension)
[](https://toolhub.wikimedia.org/tools/wikitext-vscode-extension)
[](https://github.com/Frederisk/Wikitext-VSCode-Extension/actions/workflows/build-test.yaml)
[](https://github.com/Frederisk/Wikitext-VSCode-Extension/actions?query=workflow%3ACodeQL)
[](https://www.codefactor.io/repository/github/frederisk/wikitext-vscode-extension)
[](https://mastodon.social/@rwfholme)
[](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.
## Features
- Color and style annotations of Wikitext can make it easier for users to intuitively find problems in writing grammatical formats.
- Automatic matching and closing of simple parentheses reduces unnecessary double typing.
- The special comment syntax\(``&``\) can folds the code for easy reading.
- 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.
- Enter `@[name]` to get a snippet of wikitext. Such as `@table`, `@region`, `@title`...
- 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)