Showdown Extension Boilerplate
A boilerplate that can be used to jumpstart your showdown extension development
Installation
Download the source at https://github.com/showdownjs/extension-boilerplate/archive/master.zip and extract its contents to the directory of your choice.
In order to use the boilerplate effectively, node and grunt should be installed and running in your system. Please refer to npm documentation and grunt documentation for instructions in how to properly install and configure both.
Quick Usage Guide
-
Open and edit
package.json
with your extension information. -
Install all package dependencies:
npm install -
Preprare the boilerplate and update configuration by running the following command:
grunt prepareThis task does 2 things:
- updates
bower.json
andcomponent.json
to match the contents ofpackage.json
- renames the main file in src to match
package.json
.name
attribute
Note: Don't forget to check if the values were copied properly. Also, dependencies may vary between npm, bower and compoenent.
- updates
-
A boilerplate of a generic extension is provided in
src/<your-extension-name>.js
so you can edit and build your extension file from there -
Some generic tests are also provided in
test/<your-extension-name>.js
. -
Run the lint, jscs and test case with this command:
grunt test -
Prepare your release with prepare-release