Skip to content
This repository has been archived by the owner on Feb 26, 2022. It is now read-only.

Please update README. See the official grammar repo example. #4

Open
joshgoebel opened this issue Feb 15, 2021 · 4 comments
Open

Please update README. See the official grammar repo example. #4

joshgoebel opened this issue Feb 15, 2021 · 4 comments

Comments

@joshgoebel
Copy link
Member

Example grammar meeting the spec:

https://github.com/highlightjs/highlightjs-robots-txt

It's not good to recommend users copy things into an installation of Highlight.js. If your repo is structured according to the official spec you can (by installing it inside your own highlightjs/extra) use it to build the dist folder automatically. Please see https://github.com/highlightjs/highlight.js/blob/master/extra/3RD_PARTY_QUICK_START.md

I'd suggest also adding a package.json and publishing to npm as well.

@vsoch
Copy link
Collaborator

vsoch commented Feb 15, 2021

This is a little more substantial work - I can do it in a future weekend (busy today).

@joshgoebel
Copy link
Member Author

joshgoebel commented Feb 25, 2022

Ping.

We'd also be happy to archive this repository and update the README that it needs a new maintainer if you no longer have the time for it. I've tried to be more hands off with 3rd party grammars lately but your README is actually factually incorrect, so I'd really like to get that updated.

Example of a modern 3rd party grammar README:

https://github.com/highlightjs/highlightjs-robots-txt

@vsoch
Copy link
Collaborator

vsoch commented Feb 25, 2022

@joshgoebel I rarely say no to something, but this isn't something I'm invested in doing - I don't need it for any current projects so if you need to find someone else please go ahead!

@joshgoebel
Copy link
Member Author

No problem, it's not a lifetime commitment or anything! Thanks for taking caring of things while you had the time!

# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants