mirror/reveal.js
1
0
Fork 0
mirror of https://github.com/hakimel/reveal.js.git synced 2025-08-21 22:05:55 +02:00
Code Issues Releases Wiki Activity

Created Plugin Guidelines (markdown)

Hakim El Hattab
2015-03-13 10:02:41 +01:00
parent e240319784
commit 7dad1a180f
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Plugin-Guidelines.md Normal file

@@ -0,0 +1,12 @@
This page contains guidelines for creating a reveal.js plugin.
### Separate Repository
All plugins should live in their own dedicated repositories. They should not be 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.
### 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.
### Plugin Structure
There are currently no guidelines or rules for how to structure your plugins. If your plugin consists of JavaScript you can make use of the built-in [dependency loading](https://github.com/hakimel/reveal.js#dependencies).