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:
* [Online documentation](http://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/) (french only)
* [GitLab repository](https://gitlab.com/frederic-zinelli/pyodide-mkdocs-theme)
## Guarantees:
- No cookies
- No registration
- Created by teachers for teachers
This project is a redesign of the prototype [`pyodide-mkdocs`](https://bouillotvincent.gitlab.io/pyodide-mkdocs/) initially created by [Vincent Bouillot](https://gitlab.com/bouillotvincent/).
## How it works:
The technology enabling this feat is called [Pyodide](https://pyodide.org/en/stable/). It is associated with JavaScript elements, such as [jquery.terminal](https://terminal.jcubic.pl/api_reference.php) and [ACE Editor](https://ace.c9.io/).
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](http://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/assets/pyodide-mkdocs-theme-ex.png)
Raw data
{
"_id": null,
"home_page": "http://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/",
"name": "pyodide-mkdocs-theme",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "mkdocs, mkdocs-plugin, pyodide, IDE, terminal",
"author": "Fr\u00e9d\u00e9ric Zinelli",
"author_email": "frederic.zinelli@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ed/27/a035fc359b9cf342f44742984b679a0ea51e4d7ed56afb35a4c2f4def528/pyodide_mkdocs_theme-3.2.8.tar.gz",
"platform": null,
"description": "Pyodide-MkDocs-Theme is a MkDocs theme allowing to build static websites integrating, on the client side:\n\n- IDEs (code editor),\n- Interactive Python consoles (terminals),\n- An online judge for testing user-written functions, associated with solutions and remarks,\n- And a lot of other features (auto-corrected MCQs, matplotlib, mermaid, mathjax, p5.js, ...).\n\n\n## Links:\n\n* [Online documentation](http://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/) (french only)\n* [GitLab repository](https://gitlab.com/frederic-zinelli/pyodide-mkdocs-theme)\n\n\n## Guarantees:\n\n - No cookies\n - No registration\n - Created by teachers for teachers\n\nThis project is a redesign of the prototype [`pyodide-mkdocs`](https://bouillotvincent.gitlab.io/pyodide-mkdocs/) initially created by [Vincent Bouillot](https://gitlab.com/bouillotvincent/).\n\n## How it works:\n\nThe technology enabling this feat is called [Pyodide](https://pyodide.org/en/stable/). It is associated with JavaScript elements, such as [jquery.terminal](https://terminal.jcubic.pl/api_reference.php) and [ACE Editor](https://ace.c9.io/).\n\nPyodide 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.\n\n\n## Flexible\n\nPyodide-MkDocs-Theme is highly configurable on many aspects:\n\n* Theme configuration,\n* Add your own macros to the theme,\n* Add custom logic here or there,\n* And many more...\n\n![IDE capture example](http://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/assets/pyodide-mkdocs-theme-ex.png)\n",
"bugtrack_url": null,
"license": null,
"summary": "Package embedding the necessary tools to host pyodide, ACE editors, jQuery terminals in mkdocs documentations",
"version": "3.2.8",
"project_urls": {
"Homepage": "http://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/",
"Repository": "https://gitlab.com/frederic-zinelli/pyodide-mkdocs-theme"
},
"split_keywords": [
"mkdocs",
" mkdocs-plugin",
" pyodide",
" ide",
" terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "38eb06f1c22b3a556cbf784f6c801ba4f37bfa386b2c8fb1db191d958a72e029",
"md5": "e84c5f0abd0bc90f05ec1ef0416c3d66",
"sha256": "e3aac7d891eea01447d6b0b48115bfddefe4b49684540d3d95309046af7464aa"
},
"downloads": -1,
"filename": "pyodide_mkdocs_theme-3.2.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e84c5f0abd0bc90f05ec1ef0416c3d66",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 371806,
"upload_time": "2024-11-17T13:07:24",
"upload_time_iso_8601": "2024-11-17T13:07:24.824669Z",
"url": "https://files.pythonhosted.org/packages/38/eb/06f1c22b3a556cbf784f6c801ba4f37bfa386b2c8fb1db191d958a72e029/pyodide_mkdocs_theme-3.2.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ed27a035fc359b9cf342f44742984b679a0ea51e4d7ed56afb35a4c2f4def528",
"md5": "448963353707bbe16a8a56b07fc67b83",
"sha256": "7d007ef34889e609c27288d026629de6bd78e0af61cb9f629e702cebc466f28b"
},
"downloads": -1,
"filename": "pyodide_mkdocs_theme-3.2.8.tar.gz",
"has_sig": false,
"md5_digest": "448963353707bbe16a8a56b07fc67b83",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 267925,
"upload_time": "2024-11-17T13:07:27",
"upload_time_iso_8601": "2024-11-17T13:07:27.183716Z",
"url": "https://files.pythonhosted.org/packages/ed/27/a035fc359b9cf342f44742984b679a0ea51e4d7ed56afb35a4c2f4def528/pyodide_mkdocs_theme-3.2.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-17 13:07:27",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "frederic-zinelli",
"gitlab_project": "pyodide-mkdocs-theme",
"lcname": "pyodide-mkdocs-theme"
}