|
| 1 | +--- |
| 2 | +name: Language request |
| 3 | +about: I really wish Highlight.js could highlight ... |
| 4 | +title: PLEASE read the below carefully. |
| 5 | +labels: '' |
| 6 | +assignees: '' |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +First let us say that we'd also love it if Highlight.js could highlight whichever language you're about to request support for! And there is a chance you can help make that happen! But first... |
| 11 | + |
| 12 | +...PLEASE READ THE FOLLOWING... |
| 13 | + |
| 14 | + Highlight.js does not have a fundamental plan for implementing new languages |
| 15 | + - i.e., the core team doesn't usually develop new languages. The core team |
| 16 | + instead focuses on parser development, bugs, and supporting the existing |
| 17 | + languages. They also currently does not have time to review, merge and |
| 18 | + maintain any additional languages (fixing bugs, dealing with issues, etc). |
| 19 | + |
| 20 | + Instead, the project works by encouraging 3rd party language grammars from |
| 21 | + contributors willing to help develop and maintain them. We're also happy to |
| 22 | + host those 3rd party language grammars at the ``highlightjs`` GitHub |
| 23 | + organization - no matter how obscure or weird. Or you're wlecome to host it |
| 24 | + yourself - we're still happy to link to it. |
| 25 | + |
| 26 | + This means that *there's no point in requesting a new language without also |
| 27 | + providing a 3rd party implementation* (we'll simply close "Please support |
| 28 | + language Xyz" issues with a link to this explanation). If you'd like to see |
| 29 | + a particular language available but cannot implement it, the best way to |
| 30 | + make it happen is to find another developer interested in doing so. |
| 31 | + |
| 32 | + For more info on actually developing a language see our :doc:`language-guide`, |
| 33 | + and for information on how to properly package your 3rd party language module |
| 34 | + see :doc:`language-contribution`. |
| 35 | + |
| 36 | +If you are interested in contributing a 3rd party language grammar you can start with: |
| 37 | + |
| 38 | +- https://highlightjs.readthedocs.io/en/latest/language-contribution.html |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | +You actually don't need to create this issue at all unless you have a specific question about the 3rd party language grammar creation process - which we'd be glad to answer. |
0 commit comments