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:

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

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.

IDE capture example

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.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for FredZinelli from gravatar.com FredZinelli

Credits

Author: Frédéric Zinelli

License

GNU General Public License v3 or later (GPLv3+) (GPL-3.0-or-later)

Requires

Python <4.0, >=3.9

Tags

mkdocs mkdocs-plugin pyodide IDE terminal

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyodide_mkdocs_theme-5.5.6.tar.gz (384.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyodide_mkdocs_theme-5.5.6-py3-none-any.whl (521.1 kB view details)

Uploaded Python 3

File details

Details for the file pyodide_mkdocs_theme-5.5.6.tar.gz.

File metadata

  • Download URL: pyodide_mkdocs_theme-5.5.6.tar.gz
  • Upload date:
  • Size: 384.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.10 Linux/6.8.0-136-generic

File hashes

Hashes for pyodide_mkdocs_theme-5.5.6.tar.gz
Algorithm Hash digest
SHA256 3a3e9baf10c24e0f5edb5f7e7a9a7a049d9e5fe6596fbf57146eb520d535e001
MD5 e7665366cdfe9ae362993188aaeb9466
BLAKE2b-256 ac0a822e50ef05b4ed6daee8c3ec05f6d36cc1e6e70f2cee96dae1e33b2f0841

See more details on using hashes here.

File details

Details for the file pyodide_mkdocs_theme-5.5.6-py3-none-any.whl.

File metadata

  • Download URL: pyodide_mkdocs_theme-5.5.6-py3-none-any.whl
  • Upload date:
  • Size: 521.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.10.10 Linux/6.8.0-136-generic

File hashes

Hashes for pyodide_mkdocs_theme-5.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 c3f2751a00af45e193f23d21a8999a8cef557c3f489e36f80f89c048c1179a3a
MD5 6603bb1a26bcae8e5f0e11c0a50b3c17
BLAKE2b-256 69c391dad6a668559749879529172cb0c9aed6c48c1b2ab192addd9f9db7c906

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

5.5.6

5.5.5

5.5.4

5.5.3

5.5.2

5.5.1

5.5.0

5.4.16

5.4.15

5.4.14

5.4.13

5.4.12

5.4.11

5.4.10 yanked

Reason this release was yanked:

Decided to mode the new option (qcms.reveal_rems)

5.4.9

5.4.8

5.4.7

5.4.6

5.4.5

5.4.4

5.4.3

5.4.2

5.4.1

5.4.0

5.3.6

5.3.5

5.3.4

5.3.3

5.3.2

5.3.1

5.3.0

5.2.7

5.2.6

5.2.5

5.2.4

5.2.3

5.2.2

5.2.1

5.2.0

5.1.12

5.1.11

5.1.10

5.1.9

5.1.8

5.1.7

5.1.6

5.1.5

5.1.4

5.1.3

5.1.2

5.1.1

5.1.0

5.0.5

5.0.4

5.0.3

5.0.2

5.0.1

5.0.0

5.0.0rc38 pre-release

4.5.3

4.5.2

4.5.1

4.5.0

4.4.7

4.4.6

4.4.5

4.4.4

4.4.3

4.4.2

4.4.1

4.4.0

4.3.2

4.3.1

4.3.0

4.2.10

4.2.9

4.2.8

4.2.7

4.2.6

4.2.5

4.2.4

4.2.3

4.2.2

4.2.1

4.2.0

4.1.15

4.1.14

4.1.13

4.1.12

4.1.11

4.1.10

4.1.9

4.1.8

4.1.7

4.1.6

4.1.5

4.1.4

4.1.3

4.1.2

4.1.1

4.1.0

4.0.4

4.0.2

4.0.1

4.0.0

3.2.15

3.2.14

3.2.13

3.2.12

3.2.11

3.2.10

3.2.9

3.2.8

3.2.7

3.2.6

3.2.5

3.2.4

3.2.3

3.2.2

3.2.1

3.2.0

3.1.4

3.1.3

3.1.2

3.1.1

3.1.0

3.0.2

3.0.1

3.0.0

2.5.6

2.5.5

2.5.4

2.5.3

2.5.2

2.5.1

2.5.0

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.4

2.3.3

2.3.2

2.3.1

2.3.0

2.2.0

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.0

1.5.0

1.4.1

1.4.0

1.3.0

1.2.3

1.2.2

1.2.1

1.2.0

1.1.3

1.1.2

1.1.1

1.1.0

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

0.7.1

0.7.0

0.6.1

0.6.0

0.5.0

0.4.0

0.3.3

0.3.2

0.3.1

0.3.0

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.2

0.1.1

0.1.0

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page