highlightjs / highlightjs-terraform

terraform language

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Please update README

MariannaAtPlay opened this issue · comments

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

[Highlight.js maintainer here]

refer to highlight.min.js instead of highlight.pack.js ?

I believe so. We've used .min since v10 I believe and v9 is no longer supported. Although I think the website actually still handed out pack files until recently but it no longer does.

initHighlightingOnLoad should be replaced with highlightAll

I would say so, v10 will only be supported a bit longer and we don't support older point release in any case... so someone having a problem with 10.6 would simply be instructed to upgrade to the latest minor release in the 10 series, which would then work.