1
0
mirror of https://github.com/hakimel/reveal.js.git synced 2025-08-22 22:32:57 +02:00

Updated Plugin Guidelines (markdown)

Hakim El Hattab
2015-06-03 11:11:04 +02:00
parent 99269e6cca
commit 4d13fb1687

@@ -1,9 +1,9 @@
This page contains guidelines for creating a reveal.js plugin. This page contains guidelines for creating a reveal.js plugin.
### Separate Repository ### Separate Repository
All plugins should live in their own dedicated repositories. They should not be submitted as pull requests towards the reveal.js repository. All plugins should live in their own dedicated repositories rather than being submitted as pull requests towards the reveal.js repository.
For a long time plugins have been included directly inside of this repository. However this was a poor decision from the start since it meant that issue tracking and maintenance related to the plugins were mixed with the project core, making the core increasingly hard to maintain. It's important that they remain separate so that the plugin's author is tasked with maintaining their code, rather than relying on the maintainer(s) of reveal.js. Existing plugins will eventually be moved out as well. For a long time plugins have been included directly inside of this repository. However this was a poor decision from the start since it meant that issue tracking and maintenance related to the plugins were mixed with the project core, making the core increasingly hard to maintain. It's important that they remain separate so that the plugin's author can maintaining their code separately, rather than involving the maintainer(s) of reveal.js. Existing plugins will eventually be moved out as well.
### Plugin List ### Plugin List
Please feel free to add your plugins to the [plugins page](https://github.com/hakimel/reveal.js/wiki/Plugins,-Tools-and-Hardware). This page is referenced in the project README and should be a good place for users of reveal.js to discover your plugin. Please feel free to add your plugins to the [plugins page](https://github.com/hakimel/reveal.js/wiki/Plugins,-Tools-and-Hardware). This page is referenced in the project README and should be a good place for users of reveal.js to discover your plugin.