Skip to content

Commit 999cb24

Browse files
Updated contributor docs wit info about adding language.mdx
1 parent 3bba069 commit 999cb24

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

packages/cursorless-org-docs/src/docs/contributing/adding-a-new-language.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,15 @@ You can file a PR with just these changes to get the ball rolling.
3838
## 4. Define your language's scopes
3939

4040
Follow the instructions in [Adding a new scope](./adding-a-new-scope.md) to define the scopes for your language. Note that you can file a PR for each added scope, or do a couple at a time, but it's best _**not**_ to do them all at once, as smaller PRs make the review process easier.
41+
42+
## 5. Document your language
43+
44+
Create a `.mdx` file in [`languages`](../user/languages) with the `Language` react component. The file should be named after your language, eg `java.mdx`
45+
46+
```md
47+
import { Language } from "./components/Language";
48+
49+
# Java
50+
51+
<Language languageId="java"></Language>
52+
```

0 commit comments

Comments
 (0)