Monaco-Wiki registers the Wikitext language in the Monaco Editor. It is a web version of the Visual Studio Code extensions developed by Rowe Wilson Frederisk Holme and Bhsd. The TextMate grammar is substantially revised to be site-specific and more accurate.
npm install monaco-wikiYou may load the Monaco Editor and prepare the bundle on your own:
import * as monaco from 'https://cdn.jsdelivr.net/npm/monaco-editor/+esm';
import light from 'shiki/themes/github-light.mjs';
import registerWiki, {
registerJavaScript,
registerCSS,
registerLua,
registerVue,
} from 'monaco-wiki';
await registerWiki(
monaco,
{
// (optional) Set to `true` if used in a MediaWiki site,
// or a string to specify a preset configuration (https://github.com/bhsd-harry/wikiparser-node/tree/main/config)
parserConfig: false,
// (optional) i18n language codes with a preferred order,
// e.g. `['zh-hans', 'zh-hant', 'en']
langs: ['en'],
// (optional) custom download URL for the `wikiparse` object`
cdn: 'https://cdn.jsdelivr.net/npm/wikiparser-node',
// (optional) Shiki themes
themes: [light],
// (optional) WikiLint options
lintConfig: {
// `0` ignores all, `1` ignores warnings, `2` reports all (default)
defaultSeverity: 1,
// Rules are listed at https://github.com/bhsd-harry/wikiparser-node/wiki/Rules
'no-arg': 0,
},
},
);
registerJavaScript(
monaco,
{
// (optional) custom download URL for the `eslint` object`
cdn: 'https://cdn.jsdelivr.net/npm/@bhsd/eslint-browserify',
// (optional) ESLint options
// See https://eslint.org/docs/v8.x/use/configure/
lintConfig: {
parserOptions: {
sourceType: 'module',
},
},
},
);
registerCSS(
monaco,
{
// (optional) custom download URL for the `stylelint` object`
cdn: 'https://cdn.jsdelivr.net/npm/@bhsd/stylelint-browserify',
// (optional) Stylelint options
// See https://stylelint.io/user-guide/configure/
lintConfig: {
rules: {
'length-zero-no-unit': true,
},
},
},
);
registerLua(
monaco,
{
// (optional) custom download URL for the `luacheck` object`
cdn: 'https://cdn.jsdelivr.net/npm/luacheck-browserify',
// (optional) Luacheck options
// See https://luacheck.readthedocs.io/en/stable/config.html#config-options
lintConfig: {
std: 'mediawiki',
},
},
);
await registerVue(
monaco,
{
// (optional) Shiki themes
themes: [light],
},
);or simply load the pre-bundled version from a CDN:
// Optionally specify the jsDelivr CDN, defaulting to https://fastly.jsdelivr.net
window.monaco = {CDN: 'https://cdn.jsdelivr.net'};
// Automatically loads the Monaco Editor's core and relevant workers
await import('https://cdn.jsdelivr.net/npm/monaco-wiki/dist/all.min.js');
await monaco; // The global `monaco` is a promise that resolves to the Monaco editor- wikitext
- wiki
- mediawiki
| Name | ID |
|---|---|
| Light+ | light-plus |
| Monokai | monokai |
Expand
- Redirect is only allowed at the beginning of a page (Example).
- Legacy syntax of
<tvar>tags is not supported (Example). - Nested language in
<syntaxhighlight>(Example). <nowiki>tags inside<pre>are not supported (Example).- Multiline extension tags (Examples 1, 2).
- Extension tags containing unclosed comments (Example).
- Extension tags cannot be nested in same tags (Example).
- Bracket pair colorization is problematic (Example), especially for 4 consecutive braces (left or right braces).
- Substitution is not correctly highlighted (Example).
- Non-existing parser functions starting with
#are highlighted as parser functions (Example). - Multiline template names should be invalid (Example).
- Template names containing comments are not highlighted (Example).
- Template parameter names containing newlines or comments are not highlighted (Example).
- HTML tags break the template syntax (Example).
- External links break the template syntax (Example).
- Parameter names of
#invokeare not highlighted (Example). - Conflict between transclusion and language conversion syntax (Example).
- Multiline trailing comments break section headings (Example).
- Section headings containing multiline extension tags are not highlighted (Example).
- Complex HTML tag attributes are not supported (comments,
<noinclude>/<includeonly>, templates or HTML tags). - HTML tag attributes cannot contain
>(Example). - Disallowed HTML attributes should not be highlighted (Example).
- Interaction between table cells and
<nowiki>is highlighted incorrectly (Example). - Interaction between table cells and templates is highlighted incorrectly (Example).
- Interaction between table cells and HTML tags is highlighted incorrectly (Example).
- Interaction between table cells and comments is highlighted incorrectly (Example).
- Complex table attributes are not supported (Example).
- Comments at the SOL break table syntax (Example).
||/!!after templates are not highlighted (Example).
- Multiline link targets should be invalid (Example).
- A bracket pair inside link text is highlighted incorrectly (Example).
- Link targets with templates may be highlighted incorrectly (Example).
- Lonely
[[breaks highlighting (Example). - Lists cannot be nested in file links (Example).
- Mixing bold and italic apostrophes (Example).
- External links cannot be nested in links (Example).
- Magic links cannot be nested in links (Example).
- Preformatted text with a leading space is not supported.
- One-line definition lists are not supported (Example).
- Comments at the SOL break the highlighting (Example).
- Interaction with
<nowiki>(Example).