Skip to content

Commit 54d1ed0

Browse files
committed
(chore) update docs to match issue template
1 parent 93fd0d7 commit 54d1ed0

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

docs/language-requests.rst

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,25 @@ On requesting new languages
44
This is a general answer to requests for adding new languages that appear from
55
time to time in the highlight.js issue tracker and discussion group.
66

7-
Highlight.js doesn't have a fundamental plan for implementing languages,
8-
instead the project works by encouraging development of 3rd party language
9-
grammars from contributors. We're also happy to host 3rd party language
10-
grammars at the ``highlightjs`` GitHub organization - no matter how obscure
11-
or weird.
7+
Highlight.js does not have a fundamental plan for implementing new languages
8+
- i.e., the core team doesn't usually develop new languages. The core team
9+
instead focuses on parser development, bugs, and supporting the existing
10+
languages. They also currently does not have time to review, merge and
11+
maintain any additional languages (fixing bugs, dealing with issues, etc).
12+
13+
Instead, the project works by encouraging 3rd party language grammars from
14+
contributors willing to help develop and maintain them. We're also happy to
15+
host those 3rd party language grammars at the ``highlightjs`` GitHub
16+
organization - no matter how obscure or weird. Or you're wlecome to host it
17+
yourself - we're still happy to link to it.
18+
19+
This means that *there's no point in requesting a new language without also
20+
providing a 3rd party implementation* (we'll simply close "Please support
21+
language Xyz" issues with a link to this explanation). If you'd like to see
22+
a particular language available but cannot implement it, the best way to
23+
make it happen is to find another developer interested in doing so.
24+
25+
For more info on actually developing a language see our :doc:`language-guide`,
26+
and for information on how to properly package your 3rd party language module
27+
see :doc:`language-contribution`.
1228

13-
This means that *there's no point in requesting a new language without
14-
providing an implementation for it*. If you want to see a particular language
15-
included in highlight.js but cannot implement it, the best way to make it
16-
happen is to get another developer interested in doing so. Here's our
17-
:doc:`language-guide`.

0 commit comments

Comments
 (0)