{"id":28600825,"url":"https://github.com/daizutabi/pheasant","last_synced_at":"2025-06-11T14:39:05.881Z","repository":{"id":60722550,"uuid":"115335456","full_name":"daizutabi/pheasant","owner":"daizutabi","description":"Documentation tool for Markdown conversion by Jupyter client","archived":false,"fork":false,"pushed_at":"2025-03-22T21:04:45.000Z","size":7119,"stargazers_count":16,"open_issues_count":0,"forks_count":9,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-22T22:19:03.963Z","etag":null,"topics":["html","jupyter","jupyter-kernels","markdown"],"latest_commit_sha":null,"homepage":"https://pheasant.daizutabi.net/","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/daizutabi.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}},"created_at":"2017-12-25T12:14:27.000Z","updated_at":"2025-03-22T21:04:49.000Z","dependencies_parsed_at":"2025-03-22T22:18:56.772Z","dependency_job_id":"a42ef121-d7f0-44f6-ae2b-a83c12b7c0e9","html_url":"https://github.com/daizutabi/pheasant","commit_stats":null,"previous_names":[],"tags_count":83,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daizutabi%2Fpheasant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daizutabi%2Fpheasant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daizutabi%2Fpheasant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daizutabi%2Fpheasant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/daizutabi","download_url":"https://codeload.github.com/daizutabi/pheasant/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daizutabi%2Fpheasant/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259280915,"owners_count":22833475,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["html","jupyter","jupyter-kernels","markdown"],"created_at":"2025-06-11T14:39:05.030Z","updated_at":"2025-06-11T14:39:05.845Z","avatar_url":"https://github.com/daizutabi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pheasant\n\n[![PyPI Version][pypi-v-image]][pypi-v-link]\n[![Python Version][python-v-image]][python-v-link]\n[![Build Status][GHAction-image]][GHAction-link]\n[![Coverage Status][codecov-image]][codecov-link]\n\n\nPheasant is a Markdown converter which is designed to be used as a plugin\nfor static site generators, especially MkDocs. The one of the main features\nof Pheasant is auto Markdown generation of outputs after execution of any\nPython or other language codes written in a fenced code block of Markdown source.\nThis process is executed by the Jupyter client functionality.\n\n## Setup\n\nInstall the plugin using pip:\n\n```bash\npip install pheasant\n```\n\nNext, add the following lines to your `mkdocs.yml`:\n\n```yml\nplugins:\n  - search\n  - pheasant\n```\n\n\n\u003c!-- Badges --\u003e\n[pypi-v-image]: https://img.shields.io/pypi/v/pheasant.svg\n[pypi-v-link]: https://pypi.org/project/pheasant/\n[python-v-image]: https://img.shields.io/pypi/pyversions/pheasant.svg\n[python-v-link]: https://pypi.org/project/pheasant\n[GHAction-image]: https://github.com/daizutabi/pheasant/actions/workflows/ci.yml/badge.svg?branch=main\u0026event=push\n[GHAction-link]: https://github.com/daizutabi/pheasant/actions?query=event%3Apush+branch%3Amain\n[codecov-image]: https://codecov.io/github/daizutabi/pheasant/coverage.svg?branch=main\n[codecov-link]: https://codecov.io/github/daizutabi/pheasant?branch=main\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaizutabi%2Fpheasant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaizutabi%2Fpheasant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaizutabi%2Fpheasant/lists"}