File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -20,14 +20,24 @@ A lightweight Docsify plugin that transforms standard markdown checkboxes into i
2020
2121** [ View Full Documentation & Demo →] ( https://andreferra.github.io/docsify-plugin-interactive-checkboxes/ ) **
2222
23- ## 🚀 Quick Start
23+ ## 📦 Installation
2424
25- Add to your ` index.html ` before closing ` </body> ` :
25+ ### NPM
26+
27+ ``` bash
28+ npm install docsify-interactive-checkboxes
29+ ```
30+
31+ ### CDN
32+
33+ Add the script to your ` index.html ` after the Docsify script:
2634
2735``` html
28- <script src =" https: //cdn.jsdelivr.net/gh/andreferra/ docsify-plugin- interactive-checkboxes/src /plugin.js" ></script >
36+ <script src =" //cdn.jsdelivr.net/npm/ docsify-interactive-checkboxes/dist /plugin.min .js" ></script >
2937```
3038
39+
40+
3141## 📝 Usage
3242
3343Standard markdown syntax:
Original file line number Diff line number Diff line change @@ -22,11 +22,11 @@ Try clicking these checkboxes - they'll save automatically!
2222
2323## 📦 Installation
2424
25- Add the plugin to your ` index.html ` after Docsify:
25+ Please refer to the [ Installation Guide ] ( installation.md ) for detailed instructions on using NPM or CDN.
2626
2727``` html
28- <!-- Interactive Checkboxes Plugin -->
29- <script src =" https: //cdn.jsdelivr.net/gh/andreferra/ docsify-plugin- interactive-checkboxes/src /plugin.js" ></script >
28+ <!-- Quick CDN link -->
29+ <script src =" //cdn.jsdelivr.net/npm/ docsify-interactive-checkboxes/dist /plugin.min .js" ></script >
3030```
3131
3232## 🎨 Styling
Original file line number Diff line number Diff line change 11- [ Home] ( / )
2+ - [ Installation] ( installation.md )
23- [ Demo] ( demo.md )
34- [ Configuration] ( configuration.md )
45- [ GitHub] ( https://github.com/andreferra/docsify-plugin-interactive-checkboxes )
Original file line number Diff line number Diff line change 1+ # 📦 Installation
2+
3+ There are two ways to install the Interactive Checkboxes plugin: via NPM or using a CDN.
4+
5+ ## Option 1: NPM (Recommended for Bundlers)
6+
7+ If you are using a bundler or a Node.js-based setup, you can install the package via npm.
8+
9+ ``` bash
10+ npm install docsify-interactive-checkboxes
11+ ```
12+
13+ Then, import it in your main script file if your setup supports it, or reference the file from ` node_modules ` .
14+
15+ ## Option 2: CDN (Easiest)
16+
17+ For most Docsify sites, you can simply add the script tag to your ` index.html ` . This requires no build step.
18+
19+ Add the following script ** after** the main Docsify script:
20+
21+ ``` html
22+ <!-- specific version (recommended for production) -->
23+ <script src =" //cdn.jsdelivr.net/npm/docsify-interactive-checkboxes@2/dist/plugin.min.js" ></script >
24+
25+ <!-- OR latest version -->
26+ <script src =" //cdn.jsdelivr.net/npm/docsify-interactive-checkboxes/dist/plugin.min.js" ></script >
27+ ```
28+
29+ ### Development Version
30+ If you want to use the latest unstable changes from the main branch (not recommended for production):
31+
32+ ``` html
33+ <script src =" https://cdn.jsdelivr.net/gh/andreferra/docsify-plugin-interactive-checkboxes/src/plugin.js" ></script >
34+ ```
You can’t perform that action at this time.
0 commit comments