Skip to content
/ lang-example Public template

Example/template repository for building a language package

License

Notifications You must be signed in to change notification settings

codemirror/lang-example

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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. Put your package on npm under a name like codemirror-lang-EXAMPLE.

About

Example/template repository for building a language package

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages