Skip to main content

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

Project description

Pyodide-MkDocs-Theme is a MkDocs theme allowing to build static websites integrating, on the client side:

  • IDEs (code editor),
  • Interactive Python consoles (terminals),
  • An online judge for testing user-written functions, associated with solutions and remarks,
  • And a lot of other features (auto-corrected MCQs, matplotlib, mermaid, mathjax, p5.js, ...).

Links:

Guarantees:

- No cookies
- No registration
- Created by teachers for teachers

This project is a redesign of the prototype pyodide-mkdocs initially created by Vincent Bouillot.

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.

Flexible

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 many more...

IDE capture example

Project details


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-3.2.8.tar.gz (267.9 kB view details)

Uploaded Source

Built Distribution

pyodide_mkdocs_theme-3.2.8-py3-none-any.whl (371.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyodide_mkdocs_theme-3.2.8.tar.gz
  • Upload date:
  • Size: 267.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.10.4 Linux/6.8.0-48-generic

File hashes

Hashes for pyodide_mkdocs_theme-3.2.8.tar.gz
Algorithm Hash digest
SHA256 7d007ef34889e609c27288d026629de6bd78e0af61cb9f629e702cebc466f28b
MD5 448963353707bbe16a8a56b07fc67b83
BLAKE2b-256 ed27a035fc359b9cf342f44742984b679a0ea51e4d7ed56afb35a4c2f4def528

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyodide_mkdocs_theme-3.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e3aac7d891eea01447d6b0b48115bfddefe4b49684540d3d95309046af7464aa
MD5 e84c5f0abd0bc90f05ec1ef0416c3d66
BLAKE2b-256 38eb06f1c22b3a556cbf784f6c801ba4f37bfa386b2c8fb1db191d958a72e029

See more details on using hashes here.

Supported by

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