Python Markdown extension for task lists with checkboxes
Project description
[Markdown Checklist](https://github.com/FND/markdown-checklist)
a [Python Markdown](http://pythonhosted.org/Markdown/) extension for lists of
tasks with checkboxes
inspired by
[GitHub task lists](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments):
* [ ] foo
* [x] bar
* [ ] baz
becomes
<ul>
<li><input type="checkbox" disabled> foo</li>
<li><input type="checkbox" disabled checked> bar</li>
<li><input type="checkbox" disabled> baz</li>
</ul>
* a dash can be used instead of an asterisk for list items
* both upper- and lowercase "x" are accepted to activate checkboxes
Installation
------------
$ pip install markdown-checklist
Usage
-----
import markdown
html = markdown.markdown(source, extensions=['markdown_checklist.extension'])
or
import markdown
from markdown_checklist.extension import ChecklistExtension
html = markdown.markdown(source, extensions=[ChecklistExtension()])
There is also a small JavaScript/jQuery library to make checkboxes interactive:
new Checklists("article", function(checkbox, callback) {
var uri = checkbox.closest("article").find("h1 a").attr("href");
jQuery.get(uri, callback);
}, function(markdown, checkbox, callback) {
var uri = checkbox.closest("article").find("h1 a").attr("href");
jQuery.ajax({
type: "put",
uri: uri,
data: markdown,
success: callback
});
});
See included `checklists.js` for details.
a [Python Markdown](http://pythonhosted.org/Markdown/) extension for lists of
tasks with checkboxes
inspired by
[GitHub task lists](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments):
* [ ] foo
* [x] bar
* [ ] baz
becomes
<ul>
<li><input type="checkbox" disabled> foo</li>
<li><input type="checkbox" disabled checked> bar</li>
<li><input type="checkbox" disabled> baz</li>
</ul>
* a dash can be used instead of an asterisk for list items
* both upper- and lowercase "x" are accepted to activate checkboxes
Installation
------------
$ pip install markdown-checklist
Usage
-----
import markdown
html = markdown.markdown(source, extensions=['markdown_checklist.extension'])
or
import markdown
from markdown_checklist.extension import ChecklistExtension
html = markdown.markdown(source, extensions=[ChecklistExtension()])
There is also a small JavaScript/jQuery library to make checkboxes interactive:
new Checklists("article", function(checkbox, callback) {
var uri = checkbox.closest("article").find("h1 a").attr("href");
jQuery.get(uri, callback);
}, function(markdown, checkbox, callback) {
var uri = checkbox.closest("article").find("h1 a").attr("href");
jQuery.ajax({
type: "put",
uri: uri,
data: markdown,
success: callback
});
});
See included `checklists.js` for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for markdown-checklist-nodisable-0.4.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d86695d9b42e4aef3427693e3cc575fd289d600351364545697d12ce7fd7106 |
|
MD5 | 606e9743bfb1ec02c7baaad42a0d3670 |
|
BLAKE2b-256 | dd3efa0977252823da46fc579443d8232b0d488c92c230ca2c9d3563860494d3 |