highlightjs / highlightjs/highlightjs-terraform
Please update README
- Dominant language
- JavaScript
- Stars
- 9
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
Hello,
thanks a lot for maintaining this language support!
I went through the README today as I was experimenting with this library.
I found 2 places that need to be updated:
- Should step 6 (as well as the code snippet) refer to `highlight.min.js` instead of `highlight.pack.js` ?
- In the code snippet `initHighlightingOnLoad` should be replaced with `highlightAll`
Seeing this deprecation msg:
```
Deprecated as of 10.6.0. initHighlightingOnLoad() deprecated. Use highlightAll() now.
```
I'll be happy to submit a PR if I get permissions for that.
Cheers,
Marianna
Contributor guide
No contributing guide indexed for this repository
Research direction
Start in the README and locate step 6 and its code snippet. Replace references to highlight.pack.js with highlight.min.js and initHighlightingOnLoad with highlightAll; done means the README no longer recommends the deprecated API or outdated filename.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100