Rendering Panel in GitHub markdown from nbdev

nbdev auto-generates a github readme from a notebook called index.ipynb.

However, I can not get it to render panel in any meaningful way. It simply displays the exported js script as text:

Using the embed function, I can get the widget to not just render but actually work interactively in the auto-generated docs:

[Can only put one image per post]

For the readme on Github, I have tried embed and save as found here:

But I have not been successful in making it look pretty.

Any recommendations? Thanks

In the docs:


A README is sadly never going to support embedded Javascript. I can only suggest rendering a static PNG, sadly I don’t think there’s any straightforward way to enable inline PNG output for panel objects yet, but I’d encourage you to make a feature request for that.

1 Like