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

Uploaded Source

Built Distribution

pyodide_mkdocs_theme-3.2.0-py3-none-any.whl (364.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyodide_mkdocs_theme-3.2.0.tar.gz
  • Upload date:
  • Size: 260.7 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.0.tar.gz
Algorithm Hash digest
SHA256 f84c1d414eb46074b1535ae3103fbf0ad346a0b5089141d681f3b5e52a4a7703
MD5 6c7573416e886c4de997a3981d2926c2
BLAKE2b-256 b09d022beb559f6c294fbc78d4cf4a739a7b33d438187e1b68b89063d2a14091

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for pyodide_mkdocs_theme-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b40278555e3f150124970bca57b567616f85c95254ac98de7a62aadfa9fb2902
MD5 b93093525fbfeed4d1bbba588c4d51a6
BLAKE2b-256 a0db9f23dbcd9300f21ad0e37134f08a571f205cc99be6729356dc13a829f543

See more details on using hashes here.

Provenance

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