Skip to content

Commit 2a8ff5f

Browse files
Add codemirror repo instructions
1 parent 9facbf8 commit 2a8ff5f

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

building/tracks/new/dynamic-syntax-highlighting.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,18 @@ The next step is to [Enable language](#enable-language).
4949

5050
### Create a new plugin
5151

52-
If you'd like to create plugin, you have two options for hosting:
52+
These are the steps to get going:
5353

54-
1. Create a repository on your personal account and publish it yourself.
55-
2. Have us (Exercism) create a repository and let us publish it.
56-
To do so, open a topic on [the forum](https://forum.exercism.org/c/exercism/building-exercism/125) requesting this.
54+
1. Check [our repository list for an existing `codemirror-lang-...`](https://github.com/search?q=org%3Acodemirror-lang&type=repositories) to ensure that one doesn't already exist.
55+
2. Start a new topic on [the Exercism forum][building-exercism] telling us which language you'd like to create a CodeMirror plugin for.
56+
3. Once a CodeMirror plugin repo has been created for you, implement the grammar for your track.
5757

5858
```exercism/note
59-
You could consider forking the [codemirror/lang-example repository](https://github.com/codemirror/lang-example) which implements CodeMirror support for a simple language.
59+
To help you get started, the repo created for you contains a minimal sample grammar that you can build on/tweak.
6060
```
6161

62-
Once you have a repo, follow the [language package instructions](https://codemirror.net/examples/lang-package/) to implement the plugin.
62+
We have an incredibly friendly and supportive community who will be happy to help you as you work through this!
63+
If you get stuck, please start a new topic on [the Exercism forum][building-exercism] or create new issues at [exercism/exercism][exercism-repo] as needed 🙂
6364

6465
You'll then need to publish the plugin on [NPM](https://www.npmjs.com/).
6566
The next step is to [Enable the language](#enable-language).
@@ -69,3 +70,6 @@ The next step is to [Enable the language](#enable-language).
6970
Your language's syntax (closely) resembles another language's syntax, in which case you could consider using the syntax highlighting of that language for your language.
7071
To do so, configure the track using the other language's CodeMirror plugin.
7172
See the [Enable language](#enable-language) section for more information.
73+
74+
[building-exercism]: https://forum.exercism.org/c/exercism/building-exercism/125
75+
[exercism-repo]: https://github.com/exercism/exercism

0 commit comments

Comments
 (0)