Provide a live demo of your plugin For a better user engagement create a simple live demo by using services like JSFiddle CodeSandbox CodePen and link it here in your README (attaching a screenshot/gif will also be a plus). To help you in this process here below you will find the necessary HTML/CSS/JS, so it just a matter of copy-pasting on some of those services. After that delete this part and update the link above
<link href="https://unpkg.com/grapesjs/dist/css/grapes.min.css" rel="stylesheet">
<script src="https://unpkg.com/grapesjs"></script>
<script src="https://unpkg.com/grapesjs-countup-plugin"></script>
<div id="gjs"></div>
const editor = grapesjs.init({
container: '#gjs',
height: '100%',
fromElement: true,
storageManager: false,
plugins: ['grapesjs-countup-plugin'],
});
body, html {
margin: 0;
height: 100%;
}
- Plugin name:
grapesjs-countup-plugin
- Components
component-id-1
component-id-2
- ...
- Blocks
block-id-1
block-id-2
- ...
Option | Description | Default |
---|---|---|
option1 |
Description option | default value |
- CDN
https://unpkg.com/grapesjs-countup-plugin
- NPM
npm i grapesjs-countup-plugin
- GIT
git clone https://github.com/chynixlabs/grapesjs-countup-plugin.git
Directly in the browser
<link href="https://unpkg.com/grapesjs/dist/css/grapes.min.css" rel="stylesheet"/>
<script src="https://unpkg.com/grapesjs"></script>
<script src="path/to/grapesjs-countup-plugin.min.js"></script>
<div id="gjs"></div>
<script type="text/javascript">
var editor = grapesjs.init({
container: '#gjs',
// ...
plugins: ['grapesjs-countup-plugin'],
pluginsOpts: {
'grapesjs-countup-plugin': { /* options */ }
}
});
</script>
Modern javascript
import grapesjs from 'grapesjs';
import plugin from 'grapesjs-countup-plugin';
import 'grapesjs/dist/css/grapes.min.css';
const editor = grapesjs.init({
container : '#gjs',
// ...
plugins: [plugin],
pluginsOpts: {
[plugin]: { /* options */ }
}
// or
plugins: [
editor => plugin(editor, { /* options */ }),
],
});
Clone the repository
$ git clone https://github.com/chynixlabs/grapesjs-countup-plugin.git
$ cd grapesjs-countup-plugin
Install dependencies
$ npm i
Start the dev server
$ npm start
Build the source
$ npm run build
MIT