highlightjs / highlightjs/highlightjs-bbcode

Please include both a NPM requirable file and a CDN-ready distributable

Offen
#2 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
JavaScript
Sterne
7
Forks
2
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

This issue is being opened as part of [our iniative](https://github.com/highlightjs/highlight.js/issues/3008) 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:

```

hljs.highlightAll();
```

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.