Skip to content

maelvls/madoko-vscode

Repository files navigation

Madoko for VSCode

This extension brings syntax coloring support for the Madoko language (Github) designed by Daan Leijen as a showcase for his new Koka language.

Madoko is a nice markdown dialect as well as a great editor "à la Sharelatex".

This extension is basically a copy-paste of the .tmLanguage files that are available in the madoko repository. The file extensions are .mdk and .madoko.

Screenshot showing the syntax highlighting:

screenshot

Tips

If you want to "rewrap to 80 characters" manually (⌥Q in madoko.net), you can install the extension Rewrap and map the rewrap.rewrapComment command to ⌥Q:

{
  "command": "rewrap.rewrapComment",
  "key": "alt+q",
  "when": "editorTextFocus"
}

For table re-wrapping and auto-arranging, I use Table Formatter and map the table re-wrapping to ⇧⌥Q:

{
  "command": "extension.table.formatCurrent",
  "key": "shift+alt+q",
  "when": "editorTextFocus"
}

If you want to improve the grammar

  • clone the project into your ~/.vscode/extensions (or ~/.vscode-insiders/extensions) folder:

    git clone git@github.com:maelvalais/madoko-vscode.git ~/.vscode/extensions/madoko-vscode
    
  • open it in vscode

    code ~/.vscode/extensions/madoko-vscode
    

In order to see the changes makde to syntaxes/madoko.json in your .mdk, you must reload vscode with ⇧⌘P + Reload Windows.

I also recommend to run ⇧⌘P + Inspect TM scopes in order to inspect in your .mdk in what scope each character is. This will help you finding where the faulty rule is in syntaxes/madoko.json.

For example, take this wrong highlighting on * __BOLD__; I first open Inspect TM scopes to inspect the tmLanguage scopes:

Wrong highlighting of *BOLD in a mdk file

Then, I search inside the syntaxes/madoko.json and look for the scope keyword and markup.heading.madoko:

The faulty tmgramamr rule in syntaxes/madoko.json

Note that usually, tmLanguage scopes are specific to each rule so that we can find the faulty rule easily. But here, the tmLanguage file (I did not write it) has been written à la CSS and the scopes are not really helping...

Change Log

0.0.4

  • $...$ can now span multiple lines
  • $$...$$ and $...$ are now highlighted as in the LaTex Workshop extension
  • the ~ Math block wasn't highlighted as latex code

0.0.3

  • turn word wrap on by default for the Madoko language, similarly to Markdown (contributed by kvn-s)

0.0.2

  • fixed coloring of bib citations. Example: [@ref; @ref, p. 32]. Note that 'p. 32' is not colored yet.
  • fixed coloring of entities (the madoko variables) containing - or _. Example: &my-variable;

0.0.1

  • Initial release.

About

Syntax support for the Madoko language

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published