Skip to main content

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

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()])

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markdown-checklist-0.1.0.tar.gz (2.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page