importpython-markdown

Runnable Python examples in Markdown pages, for MkDocs, Zensical and anything else built on Python-Markdown, powered by importpython.org.

Wrap a section of ordinary Markdown in #! and !# gates:

#!mpy terminal title="A first example"

A caption, rendered as normal Markdown.

```python
print("Hello, world!")
```

!#

The section becomes a runnable example: the code, a Run button, and the program's output beneath - nothing downloaded until a reader presses Run. Plain fences are the program; a fence with title="name.py" is a file delivered beside it; config and body fences carry BFP settings and page markup (escaped for you). The py and mpy types choose Pyodide or MicroPython, and terminal, debug, send-embedder-url, title="...", run-label="...", stop-label="...", theme="...", terminal-rows="...", terminal-cols="...", class and id pass through to the element - each documented at importpython.org.

Install and enable:

pip install importpython-markdown

# mkdocs.yml
markdown_extensions:
  - importpython

# zensical.toml
[project.markdown_extensions]
importpython = {}

Pre-release honesty: until BFP's first release, the default script_url points at the service's test channel, which may change; pin your own copy with the script_url option if that matters to you today.

The full documentation lives at importpython.org/docs.