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.6.5.tar.gz (407.4 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.6.5-py3-none-any.whl (546.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyodide_mkdocs_theme-5.6.5.tar.gz
  • Upload date:
  • Size: 407.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.10.10 Linux/7.0.0-30-generic

File hashes

Hashes for pyodide_mkdocs_theme-5.6.5.tar.gz
Algorithm Hash digest
SHA256 a305b4b5740d3daafd83cbf4790324a27c61fdfdcf6afde8506b23b186473bdb
MD5 f4313be2a00f53945cc5a655992bde25
BLAKE2b-256 379321b70a975c4342b995af2ea7be9a5b27260f68423436312ea39cce9c19a7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyodide_mkdocs_theme-5.6.5-py3-none-any.whl
  • Upload date:
  • Size: 546.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.4 CPython/3.10.10 Linux/7.0.0-30-generic

File hashes

Hashes for pyodide_mkdocs_theme-5.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4bb60f3f265283075b3dfa4bd5b42914d1e21d0ffee663c3496f9f8a382e1fb5
MD5 87cff3ae51023e566a99abb101251f72
BLAKE2b-256 529571d7791ec966740791bb986eb1e0b5f7b02211f1f125e647539dcf82d4b3

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

5.6.5 This release

2 files

5.6.4

2 files

5.6.3

2 files

5.6.2

2 files

5.6.1

2 files

5.6.0

2 files

5.5.6

2 files

5.5.5

2 files

5.5.4

2 files

5.5.3

2 files

5.5.2

2 files

5.5.1

2 files

5.5.0

2 files

5.4.16

2 files

5.4.15

2 files

5.4.14

2 files

5.4.13

2 files

5.4.12

2 files

5.4.11

2 files

Yanked

5.4.10

2 files

Yanked reason: Decided to mode the new option (qcms.reveal_rems)

5.4.9

2 files

5.4.8

2 files

5.4.7

2 files

5.4.6

2 files

5.4.5

2 files

5.4.4

2 files

5.4.3

2 files

5.4.2

2 files

5.4.1

2 files

5.4.0

2 files

5.3.6

2 files

5.3.5

2 files

5.3.4

2 files

5.3.3

2 files

5.3.2

2 files

5.3.1

2 files

5.3.0

2 files

5.2.7

2 files

5.2.6

2 files

5.2.5

2 files

5.2.4

2 files

5.2.3

2 files

5.2.2

2 files

5.2.1

2 files

5.2.0

2 files

5.1.12

2 files

5.1.11

2 files

5.1.10

2 files

5.1.9

2 files

5.1.8

2 files

5.1.7

2 files

5.1.6

2 files

5.1.5

2 files

5.1.4

2 files

5.1.3

2 files

5.1.2

2 files

5.1.1

2 files

5.1.0

2 files

5.0.5

2 files

5.0.4

2 files

5.0.3

2 files

5.0.2

2 files

5.0.1

2 files

5.0.0

2 files

Pre-release

5.0.0rc38

2 files

4.5.3

2 files

4.5.2

2 files

4.5.1

2 files

4.5.0

2 files

4.4.7

2 files

4.4.6

2 files

4.4.5

2 files

4.4.4

2 files

4.4.3

2 files

4.4.2

2 files

4.4.1

2 files

4.4.0

2 files

4.3.2

2 files

4.3.1

2 files

4.3.0

2 files

4.2.10

2 files

4.2.9

2 files

4.2.8

2 files

4.2.7

2 files

4.2.6

2 files

4.2.5

2 files

4.2.4

2 files

4.2.3

2 files

4.2.2

2 files

4.2.1

2 files

4.2.0

2 files

4.1.15

2 files

4.1.14

2 files

4.1.13

2 files

4.1.12

2 files

4.1.11

2 files

4.1.10

2 files

4.1.9

2 files

4.1.8

2 files

4.1.7

2 files

4.1.6

2 files

4.1.5

2 files

4.1.4

2 files

4.1.3

2 files

4.1.2

2 files

4.1.1

2 files

4.1.0

2 files

4.0.4

2 files

4.0.2

2 files

4.0.1

2 files

4.0.0

2 files

3.2.15

2 files

3.2.14

2 files

3.2.13

2 files

3.2.12

2 files

3.2.11

2 files

3.2.10

2 files

3.2.9

2 files

3.2.8

2 files

3.2.7

2 files

3.2.6

2 files

3.2.5

2 files

3.2.4

2 files

3.2.3

2 files

3.2.2

2 files

3.2.1

2 files

3.2.0

2 files

3.1.4

2 files

3.1.3

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.2

2 files

3.0.1

2 files

3.0.0

2 files

2.5.6

2 files

2.5.5

2 files

2.5.4

2 files

2.5.3

2 files

2.5.2

2 files

2.5.1

2 files

2.5.0

2 files

2.4.4

2 files

2.4.3

2 files

2.4.2

2 files

2.4.1

2 files

2.4.0

2 files

2.3.4

2 files

2.3.3

2 files

2.3.2

2 files

2.3.1

2 files

2.3.0

2 files

2.2.0

2 files

2.1.4

2 files

2.1.3

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

2.0.0

2 files

1.5.0

2 files

1.4.1

2 files

1.4.0

2 files

1.3.0

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.7.1

2 files

0.7.0

2 files

0.6.1

2 files

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page