A generic example of how to use PyScript in your mkdocs documentation. The content for the site is in the /demo-site folder. The post-build version of the site can be viewed on the gh-pages branch.
This site is viewable live on GitHub Pages, if you want to play with it online.
- Create a virtual environment of your choice
- install
mkdocsandmkdocs-pyscript - Add
mkdocs-pyscriptto your list of plugins inmkdocs.yml - Write your documentation - all codeblocks will (by default) be converted to runnable code blocks in the browser.
- Publish! (
mkdocs gh-deploy)