search

highlightjs / highlightjs-alan-if

Other
0 stars 1 forks source link

Please add a README and standard CDN `dist` folder #5

Open joshgoebel opened 3 years ago

joshgoebel commented 3 years ago

Users finding your repo from the SUPPORTED_LANGUAGES list will expect to find instructions on how to add your 3rd party grammar to their project.

Please see:

3008 is specifically related to upgrading from v10 to v11 but it still applies to the proper way to structure your repo to make it easiest to use for the most people.

tajmone commented 3 years ago

Thanks @joshgoebel, I'll read the links and update the README.

I think it would make sense if you created a repository template for custom HLJS syntaxes, which developers can use to create the codebase for their new languages.

The template would provide a boilerplate, with all the required files and directories structure (a sample language to use as a reference), repository settings (.giattributes, .gitignore, .editroconfig, etc.) and a sample README.md with instructions, which end users will only need to adapt to their new language (instructions for the developer, but also those for end users, as for this Issue).

This would simplify creating new languages for both newbies and experts alike, for with a single click they'd have a robust starting point, and newbies will also find the needed instructions.

At least, this is what I do when I'm dealing with commonly shared repository settings and structures, to avoid useless and repetitive tasks.

Furthermore, having an officially sanctioned template would dispel any confusion regarding the proper repository structure to adopt, since not all independent syntax repos are abiding to the same structure right now.

joshgoebel commented 3 years ago

Agreed, it's been mentioned - now it's a tracked issue.

joshgoebel commented 3 years ago

https://github.com/highlightjs/highlightjs-robots-txt almost serves this purpose but without any "icing" or built-in instructions.

joshgoebel commented 3 years ago

Any progress on this? Until we have a template the robots-txt repo is a good enough example.

tajmone commented 3 years ago

Any progress on this? Until we have a template the robots-txt repo is a good enough example.

Unfortunately, none yet. It's not that it's not on my TODO list, I just can't manage to find the time for it. I apologize for that, but as mentioned elsewhere, the prolonged COVID emergency is taking a toll on our lives here in Italy (we're one of the countries with the tighter restrictions and higher deaths rates in the world).

If this is becoming a problem, please feel free to archive or delete this repository. For as much as I care about this project (I wouldn't have created otherwise), right now my priorities are the well being of my family, and trying to save the working situation (or what's left of it).