https://github.com/andyexeter/jquery-plugin-boilerplate
https://github.com/andyexeter/jquery-plugin-boilerplate
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/andyexeter/jquery-plugin-boilerplate
- Owner: andyexeter
- Created: 2017-06-04T15:26:48.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-11-18T14:09:21.000Z (over 8 years ago)
- Last Synced: 2025-02-07T17:18:05.055Z (over 1 year ago)
- Language: JavaScript
- Size: 9.77 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
Awesome Lists containing this project
README
# jQuery Plugin Boilerplate
Boilerplate project to use as a starting point for jQuery plugins.
##
## Usage
* Clone the repository
* Remove the `.git` directory
* Replace the [placeholder](#Placeholders) strings within all project files
* Create a new repository:
```bash
$ git init
$ git add .
$ git commit -m "Initial commit"
```
## Placeholders
The following placeholders need to be replaced within the project:
`{{ plugin_name }}` - The name of the plugin e.g "My jQuery Plugin"
`{{ plugin_slug }}` - Slugified name of the plugin e.g "my-jquery-plugin"
`{{ plugin_file }}` - The plugin file name e.g "jquery.my-jquery-plugin.js"
`{{ plugin_file_min }}` - The minified plugin file name e.g "jquery.my-jquery-plugin.min.js"
`{{ plugin_description }}` - Description of the plugin
Use your IDE to perform a project wide search/replace.