OLD | NEW |
(Empty) | |
| 1 # [Prism](http://prismjs.com/) |
| 2 |
| 3 Prism is a lightweight, robust, elegant syntax highlighting library. It's a spin
-off project from [Dabblet](http://dabblet.com/). |
| 4 |
| 5 You can learn more on http://prismjs.com/. |
| 6 |
| 7 Why another syntax highlighter?: http://lea.verou.me/2012/07/introducing-prism-a
n-awesome-new-syntax-highlighter/#more-1841 |
| 8 |
| 9 ## Contribute to Prism! |
| 10 |
| 11 Prism depends on community contributions to expand and cover a wider array of us
e cases. If you like it, considering giving back by sending a pull request. Here
are a few tips: |
| 12 |
| 13 - Read the [documentation](http://prismjs.com/extending.html). Prism was designe
d to be extensible. |
| 14 - Do not edit prism.js, it’s just the version of Prism used by the Prism website
and is built automatically. Limit your changes to the unminified files in the c
omponents/ folder. The minified files are also generated automatically. |
| 15 - Currently the build system building prism.js and the minified files is just a
bunch of local settings in CodeKit. If someone wants to help export them to a co
nfig file, please contact me by opening an issue. |
| 16 - Please follow the code conventions used in the files already. For example, I u
se [tabs for indentation and spaces for alignment](http://lea.verou.me/2012/01/w
hy-tabs-are-clearly-superior/). Opening braces are on the same line, closing bra
ces on their own line regardless of construct. There is a space before the openi
ng brace. etc etc. |
| 17 - Please try to err towards more smaller PRs rather than few huge PRs. If a PR i
ncludes changes I want to merge and changes I don't, handling it becomes difficu
lt. |
| 18 - My time is very limited these days, so it might take a long time to review lon
ger PRs (short ones are usually merged very quickly), especially those modifying
the Prism Core. This doesn't mean your PR is rejected. |
| 19 - If you contribute a new language definition, you will be responsible for handl
ing bug reports about that language definition. Soon I plan to add usernames of
project owners for themes, plugins and language definitions so this becomes more
clear to users. |
| 20 - If you add a new language definition, theme or plugin, you need to add it to `
components.js` as well, so that it becomes available to the download build page. |
| 21 |
| 22 Thank you so much for contributing!! |
OLD | NEW |