highlightjs / highlightjs/highlightjs-alan-if

Please add a README and standard CDN `dist` folder

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

Description

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:

- https://github.com/highlightjs/highlightjs-robots-txt (a example README)
- https://github.com/highlightjs/highlight.js/issues/3008

#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.

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare the repository with the linked highlightjs-robots-txt README and the guidance in highlight.js issue #3008. Add usage instructions for the third-party grammar and arrange the repository with the standard CDN dist folder; done means users can find integration guidance and the expected distributable files.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation, release
Issue type
Documentation
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.