Skip to content

mkdocs-feather

Live code execution for MkDocs using Feather.

Usage

In your markdown file, you can say:

```{ .python .feather }
print("Hello, World!")
```

It will render as:

print("Hello, World!")

Features

  • Code highlighting
  • Multi-file support
  • Specify environment variables / CLI args for execution

Installation

Add "mkdocs-feather" to plugins in your mkdocs.yml config.

site_name: My Docs 
plugins:
    - feather

Configuration

You can configure mkdocs.yml to use your own self-hosted Feather runtime or specify modes that map to particular syntax-highlighting classes or runtimes.

plugins:
    - feather:
        server_url: https://feather-demo.herokuapp.com/