Skip to content

Latest commit

 

History

History
21 lines (11 loc) · 1.06 KB

README.md

File metadata and controls

21 lines (11 loc) · 1.06 KB
Raw

CodeMirror 6 language package template

This is an example repository containing a minimal CodeMirror language support package. The idea is to clone it, rename it, and edit it to create support for a new language.

Things you'll need to do (see the language support example for a more detailed tutorial):

  • git grep EXAMPLE and replace all instances with your language name.

  • Rewrite the grammar in src/syntax.grammar to cover your language. See the Lezer system guide for information on this file format.

  • Adjust the metadata in src/index.ts to work with your new grammar.

  • Adjust the grammar tests in test/cases.txt.

  • Build (npm run prepare) and test (npm test).

  • Rewrite this readme file.

  • Optionally add a license.

  • Publish. If you want to use a @codemirror/lang-... package name, open an issue to ask for npm publish rights for that name.