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,
- compatibility to use from pyodide:
- [p5.js animations](https://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/p5_processing/how_to/#p5-simple-example)
- dynamic [matplotlib](https://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/custom/matplotlib/#exemple-simple) drawings
- PIL
- [dynamic mermaid graphs](https://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/custom/mermaid/#mermaid-simple-example)
- mathjax
- ...
## Links:
* [Online documentation](http://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/) (french only)
* [GitLab repository](https://gitlab.com/frederic-zinelli/pyodide-mkdocs-theme)
## 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...
## Guarantees:
- No cookies
- No registration
- Created by teachers for teachers
This project is a complete redesign of the prototype [`pyodide-mkdocs`](https://bouillotvincent.gitlab.io/pyodide-mkdocs/) from [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.
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/6e/a2/40f65ea03bca7152cc35bda47977a1db82f2e5a01443036bf3de2c1f521c/pyodide_mkdocs_theme-4.2.4.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\nAnd a lot of other features:\n\n- auto-corrected MCQs,\n- compatibility to use from pyodide:\n - [p5.js animations](https://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/p5_processing/how_to/#p5-simple-example)\n - dynamic [matplotlib](https://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/custom/matplotlib/#exemple-simple) drawings\n - PIL\n - [dynamic mermaid graphs](https://frederic-zinelli.gitlab.io/pyodide-mkdocs-theme/custom/mermaid/#mermaid-simple-example)\n - mathjax\n- ...\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## 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\n\n\n## Guarantees:\n\n - No cookies\n - No registration\n - Created by teachers for teachers\n\nThis project is a complete redesign of the prototype [`pyodide-mkdocs`](https://bouillotvincent.gitlab.io/pyodide-mkdocs/) from [Vincent Bouillot](https://gitlab.com/bouillotvincent/).\n\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",
"bugtrack_url": null,
"license": null,
"summary": "Package embedding the necessary tools to host pyodide, ACE editors, jQuery terminals in mkdocs documentations",
"version": "4.2.4",
"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": "a3c7731bee14b5f3b7d2f0b7b7d70f492871ac8bcbc3e8eb37fbf5330df95d24",
"md5": "c58292987fb81c0871e14fbc5cb4f584",
"sha256": "60c168c62a17b29cb6975133c450d16456021e8c2d2e68e76202d9de915081fc"
},
"downloads": -1,
"filename": "pyodide_mkdocs_theme-4.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c58292987fb81c0871e14fbc5cb4f584",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 404179,
"upload_time": "2025-02-23T13:58:12",
"upload_time_iso_8601": "2025-02-23T13:58:12.565676Z",
"url": "https://files.pythonhosted.org/packages/a3/c7/731bee14b5f3b7d2f0b7b7d70f492871ac8bcbc3e8eb37fbf5330df95d24/pyodide_mkdocs_theme-4.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ea240f65ea03bca7152cc35bda47977a1db82f2e5a01443036bf3de2c1f521c",
"md5": "07fae667fb34aa575026f53c61a8f3bb",
"sha256": "cf88b7b0e49bff2989483bd35ca24bd783c423e24fbabff0c6e58a80c23080ac"
},
"downloads": -1,
"filename": "pyodide_mkdocs_theme-4.2.4.tar.gz",
"has_sig": false,
"md5_digest": "07fae667fb34aa575026f53c61a8f3bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 298398,
"upload_time": "2025-02-23T13:58:15",
"upload_time_iso_8601": "2025-02-23T13:58:15.159614Z",
"url": "https://files.pythonhosted.org/packages/6e/a2/40f65ea03bca7152cc35bda47977a1db82f2e5a01443036bf3de2c1f521c/pyodide_mkdocs_theme-4.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-23 13:58:15",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "frederic-zinelli",
"gitlab_project": "pyodide-mkdocs-theme",
"lcname": "pyodide-mkdocs-theme"
}
JSON