{"id":23605736,"url":"https://github.com/tombreit/mkdocs-quizdown-plugin","last_synced_at":"2026-02-13T07:08:00.202Z","repository":{"id":269955433,"uuid":"908375079","full_name":"tombreit/mkdocs-quizdown-plugin","owner":"tombreit","description":"Allows embedding quizdown-js quizzes in MkDocs pages.","archived":false,"fork":false,"pushed_at":"2025-03-07T08:27:36.000Z","size":902,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-24T22:40:31.371Z","etag":null,"topics":["mkdocs","mkdocs-plugin","quiz"],"latest_commit_sha":null,"homepage":"https://tombreit.github.io/mkdocs-quizdown-plugin/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tombreit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-12-25T22:54:41.000Z","updated_at":"2025-08-05T01:19:33.000Z","dependencies_parsed_at":"2025-03-07T01:22:59.808Z","dependency_job_id":"c9f78ef7-37d0-46d2-9216-58de7b714375","html_url":"https://github.com/tombreit/mkdocs-quizdown-plugin","commit_stats":null,"previous_names":["tombreit/mkdocs-quizdown-plugin"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/tombreit/mkdocs-quizdown-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombreit%2Fmkdocs-quizdown-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombreit%2Fmkdocs-quizdown-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombreit%2Fmkdocs-quizdown-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombreit%2Fmkdocs-quizdown-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tombreit","download_url":"https://codeload.github.com/tombreit/mkdocs-quizdown-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tombreit%2Fmkdocs-quizdown-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29398158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T06:24:03.484Z","status":"ssl_error","status_checked_at":"2026-02-13T06:23:12.830Z","response_time":78,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mkdocs","mkdocs-plugin","quiz"],"created_at":"2024-12-27T13:12:46.975Z","updated_at":"2026-02-13T07:08:00.187Z","avatar_url":"https://github.com/tombreit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\nSPDX-FileCopyrightText: 2024 Thomas Breitner\n\nSPDX-License-Identifier: MIT\n--\u003e\n\n# mkdocs-quizdown-plugin\n\n**🔥 This is work in progress - no liability for nothing.**\n\n- Allows embedding [quizdown-js](https://github.com/bonartm/quizdown-js) quizzes in MkDocs pages\n- Multiple quizzes can be embedded on multiple pages, and/or\n- Multiple quizzes can be embedded on one page\n- `quizdown-js` Javascript library included, no CDNs involved\n\n## Demo\n\n\u003chttps://tombreit.github.io/mkdocs-quizdown-plugin/\u003e\n\n## Install\n\n### via PyPI\n\n\u003chttps://pypi.org/project/mkdocs-quizdown-plugin/\u003e\n\n```bash\npip install mkdocs-quizdown-plugin\n```\n\n### Development version via git\n\n```bash\n# Initial install:\npython -m pip install \\\n  'mkdocs-quizdown-plugin @ git+https://github.com/tombreit/mkdocs-quizdown-plugin'\n\n# Upgrade plugin:\npython -m pip install \\\n  --upgrade --no-deps --force-reinstall \\\n  'mkdocs-quizdown-plugin @ git+https://github.com/tombreit/mkdocs-quizdown-plugin'\n```\n\nYou can use the requirement item `'mkdocs-quizdown-plugin @ git+https://github.com/tombreit/mkdocs-quizdown-plugin'` in your `requirements.txt`:\n\n```text\n# file: requirements.txt\n\nmkdocs\nmkdocs-quizdown-plugin @ git+https://github.com/tombreit/mkdocs-quizdown-plugin\n```\n\n## Configuration\n\nSee [`mkdocs.yml`](https://github.com/tombreit/mkdocs-quizdown-plugin/blob/main/mkdocs.yml)\n\n## Usage\n\nEmbed your quiz as a Markdown block in your MkDocs Markdown page and enclose it with the mkdocs-quizdown start (`:::{quizdown}`) and end markers (`:::`):\n\n```md\n# Quiz\n\nSome **markdown** content.\n\n:::{quizdown}\n\n---\nprimaryColor: steelblue\nshuffleQuestions: false\nshuffleAnswers: true\n---\n\n# What is the capital of France?\n\n\u003e Paris is the capital and largest city of France.\n\n1. [x] Paris\n2. [ ] London\n3. [ ] Berlin\n4. [ ] Madrid\n\n:::\n\nSome **markdown** content.\n```\n\n- Try the [quizdown live editor](https://bonartm.github.io/quizdown-live-editor/) from the author of `quizdown-js` to prepare your quiz markdown\n- [quizdown-js configuration options](https://github.com/bonartm/quizdown-js/blob/main/docs/options.md)\n- MkDocs integration demo: [`docs/index.md`](docs/index.md)\n\n## Credits\n\n- [quizdown-js by Malte Bonart](https://github.com/bonartm/quizdown-js)\n- [MkDocs](https://www.mkdocs.org/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftombreit%2Fmkdocs-quizdown-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftombreit%2Fmkdocs-quizdown-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftombreit%2Fmkdocs-quizdown-plugin/lists"}