Users finding your repo from the SUPPORTED_LANGUAGES list will expect to find instructions on how to add your 3rd party grammar to their project.

Please see:

• https://github.com/highlightjs/highlightjs-robots-txt (a example README)
• highlightjs/highlight.js#3008

#3008 is specifically related to upgrading from v10 to v11 but it still applies to the proper way to structure your repo to make it easiest to use for the most people.

Updated:

This issue is being opened as part of our iniative to make all 3rd party grammars:

• easier to use for all end users
• internally a bit more consistent (both to help end users and also encourage cross-maintenance)
• ready to go for version 11

Please include a dist folder that includes a ready-to-go CDN distributable that can be used with a single line of JS. IE, our simple 3 install should "just work" without any other code or markup:

<script type="text/javascript" src="/path/to/highlight.min.js"></script>
<script type="text/javascript" src="/path/to/highlightjs-GN/GN.js"></script>
<script type="text/javascript">hljs.highlightAll();</script>

Your README optimally would also document this usage. Please see the robots-txt repository for a usage example.

• https://github.com/highlightjs/highlightjs-robots-txt#static-website-or-simple-usage

Our build system can generate this file for you (and we recommend that). Using our internal build system also allows you to easily check your grammar for exponential or polynomical run-away regular expressions.

• https://github.com/highlightjs/highlight.js/blob/main/extra/3RD_PARTY_QUICK_START.md#packaging

If you have any questions, feel free to ask!

Thanks,
Highlight.js Maintainer

@petrhosek

If you no longer have time to maintain this anymore we'll need mark it archived and I'll add a notice to the README that it's currently unmaintained and in need of a maintainer.

Please let me know.

Thanks,

Contribute to the thought process for 3rd party language packaging if you'd like

As a maintainer of a Highlight.js language grammar you might be interested in the discussion of an official packaging format. I just created an issue to track the discussion and I've been working on this along with the new build system.

highlightjs/highlight.js#2328

Sorry for the spam, but I couldn't think of an easier way to ping the people who might be most interested in weighing in on the subject. Feel free to simply close this issue or leave it open (whatever works best for you!).