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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyodide_mkdocs_theme-5.6.0.tar.gz.
File metadata
- Download URL: pyodide_mkdocs_theme-5.6.0.tar.gz
- Upload date:
- Size: 404.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.1.4 CPython/3.10.10 Linux/7.0.0-28-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
41781e1b6e018592e166ab8dd9bdd9b7ba3c4343c27a419e154fb293b40568a6
|
|
| MD5 |
fc96042ab834b9ab42e7021921856d6e
|
|
| BLAKE2b-256 |
467d435143c76a232102f0fd988818b0d91a37d5d2cd841a70160c69c38134d6
|
File details
Details for the file pyodide_mkdocs_theme-5.6.0-py3-none-any.whl.
File metadata
- Download URL: pyodide_mkdocs_theme-5.6.0-py3-none-any.whl
- Upload date:
- Size: 543.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.1.4 CPython/3.10.10 Linux/7.0.0-28-generic
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
838e78ca2f58b9250469716aa3d04616980ebb4119179e9170bd04c84aba6620
|
|
| MD5 |
bff6b7d1002ccf38743511f85daa141c
|
|
| BLAKE2b-256 |
eb002254f44103bdabb43419a773ecf68cb86c13ecf3db30cb525f13a739b107
|
