Skip to content

andreferra/docsify-plugin-interactive-checkboxes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Docsify Interactive Checkboxes Plugin

GitHub Pages npm version License: MIT

A lightweight Docsify plugin that transforms standard markdown checkboxes into interactive, persistent task lists.

✨ Features

  • πŸ–±οΈ Interactive Checkboxes - Click to toggle completion
  • πŸ’Ύ Persistent State - Saved in localStorage with stable IDs (v2)
  • πŸ“„ Per-Page Storage - Each page has its own states
  • 🎨 Visual Feedback - Strikethrough + fade effect
  • πŸ“€ Import/Export - Backup your progress easily
  • ⚑ Zero Dependencies - Pure JavaScript
  • πŸš€ Easy Integration - Drop-in solution

πŸ“– Documentation

View Full Documentation & Demo β†’

πŸ“¦ Installation

NPM

npm install docsify-interactive-checkboxes

CDN

Add the script to your index.html after the Docsify script:

<script src="//cdn.jsdelivr.net/npm/docsify-interactive-checkboxes/dist/plugin.min.js"></script>

πŸ“ Usage

Standard markdown syntax:

- [ ] Unchecked task
- [x] Completed task
- [ ] Another task

πŸ“„ License

MIT License - see LICENSE

About

Lightweight Docsify plugin for interactive, persistent checkboxes in markdown documentation

Resources

License

Stars

Watchers

Forks