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.
1 maintainer
Release files for pyodide-mkdocs-theme 5.6.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pyodide_mkdocs_theme-5.6.5.tar.gz | 407.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pyodide_mkdocs_theme-5.6.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 953.5 kB
Release files / pyodide_mkdocs_theme-5.6.5.tar.gz
| Download URL | pyodide_mkdocs_theme-5.6.5.tar.gz |
|---|---|
| Size | 407.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a305b4b5740d3daafd83cbf4790324a27c61fdfdcf6afde8506b23b186473bdb
|
|
BLAKE2b-256 checksum How to use checksums |
379321b70a975c4342b995af2ea7be9a5b27260f68423436312ea39cce9c19a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.4 CPython/3.10.10 Linux/7.0.0-30-generic
|
Release files / pyodide_mkdocs_theme-5.6.5-py3-none-any.whl
| Download URL | pyodide_mkdocs_theme-5.6.5-py3-none-any.whl |
|---|---|
| Size | 546.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4bb60f3f265283075b3dfa4bd5b42914d1e21d0ffee663c3496f9f8a382e1fb5
|
|
BLAKE2b-256 checksum How to use checksums |
529571d7791ec966740791bb986eb1e0b5f7b02211f1f125e647539dcf82d4b3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.1.4 CPython/3.10.10 Linux/7.0.0-30-generic
|
