pycmarkgfm

https://github.com/zopieux/pycmarkgfm
Admin
pycmarkgfm provides lightweight Python bindings to GitHub Flavored Markdown (cmark-gfm) with...
Tokens:3,309
Snippets:25
Trust Score:7.8
License:GPL-3.0
Update:4 days ago
Show doc for...
Tokens:
Raw
### Install pycmarkgfm

Source: https://github.com/zopieux/pycmarkgfm/blob/master/README.md

Install the package using pip.

```bash
$ pip install pycmarkgfm
```

--------------------------------

### Apply Rendering Options

Source: https://github.com/zopieux/pycmarkgfm/blob/master/README.md

Use the options module to apply flags like unsafe or hardbreaks via bitwise-or.

```python
text = "hello\n<img src='doge.png'>"

print(pycmarkgfm.markdown_to_html(text))
# <p>hello
# <!-- raw HTML omitted --></p>

from pycmarkgfm import options
print(pycmarkgfm.markdown_to_html(text, options=options.unsafe | options.hardbreaks))
# <p>hello<br />
# <img src='doge.png'></p>
```

--------------------------------

### Convert Markdown to HTML

Source: https://github.com/zopieux/pycmarkgfm/blob/master/README.md

Use markdown_to_html for CommonMark or gfm_to_html for GitHub Flavored Markdown.

```python
import pycmarkgfm

# CommonMark (not GitHub flavored):
html = pycmarkgfm.markdown_to_html("Hello *world*")

# GitHub flavored Markdown:
html = pycmarkgfm.gfm_to_html("Hello ~world~")
```

--------------------------------

### Parse and Toggle Task Lists

Source: https://github.com/zopieux/pycmarkgfm/blob/master/README.md

Use parse_gfm to access task objects and update their checked state.

```python
import pycmarkgfm

md = """
- [ ] eggs
- [x] milk
"""

with pycmarkgfm.parse_gfm(md) as document: 
    eggs, milk = document.get_tasks()
    assert not eggs.checked
    assert milk.checked

    # Toggle! 
    eggs.checked = True
    print(document.to_commonmark())
    # - [x] eggs
    # - [x] milk
```

--------------------------------

### Toggle Tasks via HTML Attributes

Source: https://github.com/zopieux/pycmarkgfm/blob/master/README.md

Use the data-gfm-task attribute to identify and toggle tasks programmatically.

```python
import pycmarkgfm

md = """
- [ ] eggs
- [x] milk
"""

print(pycmarkgfm.gfm_to_html(md))
# <ul>
# <li data-gfm-task="2:1-2:10"><input type="checkbox" disabled="" /> eggs</li>
# <li data-gfm-task="3:1-3:10"><input type="checkbox" checked="" disabled="" /> milk</li>
# </ul>

# When user clicks a checkbox, get the parent 'data-gfm-task', then on the server, do:
new_md = pycmarkgfm.gfm_toggle_task_by_id(md, "2:1-2:10", checked=pycmarkgfm.TOGGLE)
print(new_md)
# - [x] eggs
# - [x] milk
```
Tokens:
Raw