{"id":15292099,"url":"https://github.com/linsir/markdown-it-task-checkbox","last_synced_at":"2025-04-13T09:32:26.969Z","repository":{"id":46302333,"uuid":"68826018","full_name":"linsir/markdown-it-task-checkbox","owner":"linsir","description":"A markdown-it plugin to create GitHub-style task lists with checkbox","archived":false,"fork":false,"pushed_at":"2021-11-01T05:23:19.000Z","size":29,"stargazers_count":26,"open_issues_count":4,"forks_count":12,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-09T16:54:45.024Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/linsir.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-21T14:36:31.000Z","updated_at":"2024-08-12T04:36:32.000Z","dependencies_parsed_at":"2022-09-19T09:40:13.052Z","dependency_job_id":null,"html_url":"https://github.com/linsir/markdown-it-task-checkbox","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linsir%2Fmarkdown-it-task-checkbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linsir%2Fmarkdown-it-task-checkbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linsir%2Fmarkdown-it-task-checkbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/linsir%2Fmarkdown-it-task-checkbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/linsir","download_url":"https://codeload.github.com/linsir/markdown-it-task-checkbox/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248690896,"owners_count":21146228,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-30T16:16:30.930Z","updated_at":"2025-04-13T09:32:26.279Z","avatar_url":"https://github.com/linsir.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# markdown-it-task-checkbox\n\nA [markdown-it](https://www.npmjs.com/package/markdown-it) plugin to create GitHub-style [task lists](https://github.com/blog/1825-task-lists-in-all-markdown-documents)\n\nModified from \u003chttps://github.com/mcecot/markdown-it-checkbox\u003e and \u003chttps://github.com/revin/markdown-it-task-lists\u003e\n\n\n## Usage\n\n## Install\n\nnode.js:\n\n```bash\nnpm install markdown-it-task-checkbox --save\n```\n\n## Use\n\n```js\nvar md = require('markdown-it')()\n            .use(require('markdown-it-task-checkbox'),{\n              disabled: true,\n              divWrap: false,\n              divClass: 'checkbox',\n              idPrefix: 'cbx_',\n              ulClass: 'task-list',\n              liClass: 'task-list-item'\n            });\n\nmd.render('- [x] unchecked') // =\u003e\n// \u003cul class=\"task-list\"\u003e\n//  \u003cli class=\"task-list-item\"\u003e\n//     \u003cdiv classname=\"checkbox\"\u003e\n//       \u003cinput type=\"checkbox\" id=\"cbx_0\" checked=\"true\" disabled=\"true\"\u003e\n//       \u003clabel for=\"cbx_0\"\u003eunchecked\u003c/label\u003e\n//     \u003c/div\u003e\n//  \u003c/li\u003e\n// \u003c/ul\u003e\n```\n\n_Differences in browser._ If you load script directly into the page, without\npackage system, module will add itself globally as `window.markdownitCheckbox`.\n\n## Options\n\n\n## disabled\n\n* **Type:** `Boolean`\n* **Default:** `true`\n\nif the value is true, the checkbox can not be selected.\n\n## divWrap\n\n* **Type:** `Boolean`\n* **Default:** `false`\n\nwrap div arround checkbox. this makes it possible to use it for example with [Awesome Bootstrap Checkbox](https://github.com/flatlogic/awesome-bootstrap-checkbox/).\n\n## divClass\n\n* **Type:** `String`\n* **Default:** `checkbox`\n\nclassname of div wrapper. will only be used if `divWrap` is enanbled.\n\n## idPrefix\n\n* **Type:** `String`\n* **Default:** `cbx_`\n\nthe id of the checkboxs input contains the prefix and an incremental number starting with `0`. i.e. `cbx_1` for the 2nd checkbox.\n\n## ulClass\n\n* **Type:** `String`\n* **Default:** `task-list`\n\nclassname of ul wrapper.\n\n## liClass\n\n* **Type:** `String`\n* **Default:** `task-list-item`\n\nclassname of li wrapper.\n\n## THANKS\n\n\u003chttps://github.com/mcecot/markdown-it-checkbox\u003e and \u003chttps://github.com/revin/markdown-it-task-lists\u003e\n\n## License\n\nMIT License © 2016 Linsir\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinsir%2Fmarkdown-it-task-checkbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flinsir%2Fmarkdown-it-task-checkbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flinsir%2Fmarkdown-it-task-checkbox/lists"}