Metadata-Version: 1.0
Name: markdown-checklist
Version: 0.4.1
Summary: Python Markdown extension for task lists with checkboxes
Home-page: https://github.com/FND/markdown-checklist
Author: FND
Author-email: UNKNOWN
License: MIT
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.
Platform: Posix; MacOS X; Windows
