highlightjs / highlightjs/highlightjs-terraform

Please include `dist` folder with CDN distributable

Open
#6 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
9
Forks
8
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the repository README and the packaging section of extra/3RD_PARTY_QUICK_START.md, then compare the usage example in the linked highlightjs-robots-txt repository. Done means a generated dist folder provides the Terraform CDN distributable and the README documents the three-script usage shown in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
build-system, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.