# mistlefoot


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

## Installation

``` bash
pip install mistlefoot
```

## Features

- **Subscript & Superscript**: `H~2~O` and `E=mc^2^`
- **Highlighting**: `==marked text==`
- **Strikethrough**: `~~deleted text~~`
- **Emojis**: `:smile:` `:rocket:` `:heart:` (50+ supported)
- **Auto-linking**: URLs automatically become clickable links
- **Footnotes**: `Reference[^1]` with definitions
- **Task lists**: GitHub-style checkboxes
- **Heading attributes**: Add IDs, classes, and custom attributes to
  headings

## Usage

``` python
from IPython.display import HTML,Markdown,display
from mistletoe import markdown
```

``` python
markdown('**aa**', ExtendedHtmlRenderer)
```

    '<p><strong>aa</strong></p>\n'

``` python
def render_md(md): return HTML(markdown(md, ExtendedHtmlRenderer))
def  print_md(md):       print(markdown(md, ExtendedHtmlRenderer))
```

``` python
markdown_text = """
#### My Document {#intro .important}

This is **H~2~O** and ==highlighted text==.

Check out https://fast.ai :rocket:

- [x] Done
- [ ] Todo
"""

render_md(markdown_text)
```

<h4 id="intro" class="important">My Document</h4>
<p>This is <strong>H<sub>2</sub>O</strong> and <mark>highlighted text</mark>.</p>
<p>Check out <a href="https://fast.ai">https://fast.ai</a> 🚀</p>
<ul>
<li><input type="checkbox" disabled checked> Done</li>
&#10;<li><input type="checkbox" disabled > Todo</li>
&#10;</ul>

## Examples

**Scientific notation:**

``` python
render_md("H~2~O and E=mc^2^")
```

<p>H<sub>2</sub>O and E=mc<sup>2</sup></p>

**Emojis:**

``` python
render_md("Great work! :tada: :100:")
```

<p>Great work! 🎉 💯</p>

**Footnotes:**

``` python
render_md("""Here's a claim[^1].

[^1]: This is the supporting reference.""")
```

<p>Here's a claim<sup><a href="#fn-1" id="fnref-1">[1]</a></sup>.</p>
<div id="fn-1" class="footnote"><sup>1</sup> This is the supporting reference. <a href="#fnref-1">↩</a></div>

**Heading attributes:**

``` python
print_md('#### Section {#my-id .important data-level=\"1\"}')
```

    <h4 id="my-id" class="important" data-level="1">Section</h4>

## Contributing

By Jeremy Howard. Copyright ©️ fast.ai 2026 onwards. Contributions
welcome.
