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


Release history Release notifications | RSS feed

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

Uploaded Source

Built Distribution

pyodide_mkdocs_theme-3.2.10-py3-none-any.whl (377.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyodide_mkdocs_theme-3.2.10.tar.gz
Algorithm Hash digest
SHA256 200cf0ec64070aad387a70dcfff636677de9d6fa5e8e7ef36daac5d9746ddda8
MD5 edb9998184f6794efde20116348dfc64
BLAKE2b-256 50a9065e84f052859335d5accec163d6c41a29b4173551818f84f9d6d5d0b0fe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pyodide_mkdocs_theme-3.2.10-py3-none-any.whl
Algorithm Hash digest
SHA256 46ddd28b6d3efcf36251952fca0ff14070be1cdd19138caa078845b4a48426a3
MD5 06017d519c270efa1b85dd12045347af
BLAKE2b-256 ef13c3dce32d528a7240a879937630fc3b120927e11b0f053b9d3477c585e796

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