highlightjs / highlightjs-bbcode Goto Github PK

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-bbcode/bbcode.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

You only have a single file now... which doesn't work with Node.js. Your source file should have a single export (the language function).. your distributable file should include the registerLanguage call. See the robots-txt repository linked to above for examples (I see you forked from that repo).

IE, the src/languages/bbcode.js file is the one you maintain (and can be required by Node.js, etc), and the dist/bbcode.min.js file is the one that our build system would auto-generate for you.

This project is currently unmaintained and could use a new maintainer. If interested, please respond here.