pyodide-mkdocs-theme 5.5.1

Package embedding the necessary tools to host pyodide, ACE editors, jQuery terminals in mkdocs documentations

Pyodide-MkDocs-Theme is a MkDocs theme for building static websites that allow to run Python code in browser as:

• code editor snippets (IDEs),
• interactive Python consoles (terminals),
• instant assessments for user-written functions associated with solutions for excercises and instructor remarks.

There are many additional features including auto-corrected multiple choice questions (MCQs) and compatibility to use:

• p5.js animations,
• dynamic matplotlib drawings,
• PIL,
• dynamic mermaid graphs, and
• mathjax syntax.

Guarantees

• There are no cookies
• No registration needed
• Created by teachers for teachers and students

Quickstart

The following commands should install pyodide_mkdocs_theme, scaffold a new project and serve a sample website that you can open a browser, usually at http://127.0.0.1:8000/.

pip install pyodide_mkdocs_theme
python -m pyodide_mkdocs_theme --new your_project_name
cd your_project_name
pip install -r requirements.txt
mkdocs serve

Note: you will need to add site_url parameter in mkdocs.yml in order to run mkdocs build command.

Links

• Online documentation (French only)
• GitLab repository

Flexibility

Pyodide-MkDocs-Theme is highly configurable on many aspects:

• theme configuration,
• add your own macros to the theme,
• add custom logic here or there,
• and quite a few other options.

How it works

The technology enabling this feat is called Pyodide. It is associated with JavaScript elements such as jquery.terminal and ACE Editor.

Pyodide uses WebAssembly to bridge between Python and JavaScript and provide an environment for manipulating the JavaScript DOM with Python, or vice versa for manipulating Python from JavaScript.

Pyodide-MkDocs-Theme is based on a modern mkdocs-material theme for MkDocs static site generator.

Project history

This project is a complete redesign of the prototype pyodide-mkdocs from Vincent Bouillot.