{"id":45188030,"url":"https://github.com/mkdocstrings/griffe2md","last_synced_at":"2026-02-20T11:05:59.499Z","repository":{"id":164010054,"uuid":"639483927","full_name":"mkdocstrings/griffe2md","owner":"mkdocstrings","description":"Output API docs to Markdown using Griffe.","archived":false,"fork":false,"pushed_at":"2026-02-05T16:39:11.000Z","size":1988,"stargazers_count":16,"open_issues_count":9,"forks_count":4,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-06T02:54:39.902Z","etag":null,"topics":["api","docs","griffe","markdown"],"latest_commit_sha":null,"homepage":"https://mkdocstrings.github.io/griffe2md/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkdocstrings.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"pawamoy","polar":"pawamoy"}},"created_at":"2023-05-11T14:43:25.000Z","updated_at":"2026-02-05T16:44:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"bde8f7d9-af7e-41e8-bab2-2fe820858d4c","html_url":"https://github.com/mkdocstrings/griffe2md","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/mkdocstrings/griffe2md","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe2md","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe2md/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe2md/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe2md/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdocstrings","download_url":"https://codeload.github.com/mkdocstrings/griffe2md/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocstrings%2Fgriffe2md/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29648552,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-20T09:27:29.698Z","status":"ssl_error","status_checked_at":"2026-02-20T09:26:12.373Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":["api","docs","griffe","markdown"],"created_at":"2026-02-20T11:05:58.711Z","updated_at":"2026-02-20T11:05:59.492Z","avatar_url":"https://github.com/mkdocstrings.png","language":"Python","funding_links":["https://github.com/sponsors/pawamoy","https://polar.sh/pawamoy"],"categories":[],"sub_categories":[],"readme":"# griffe2md\n\n[![ci](https://github.com/mkdocstrings/griffe2md/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe2md/actions?query=workflow%3Aci)\n[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe2md/)\n[![pypi version](https://img.shields.io/pypi/v/griffe2md.svg)](https://pypi.org/project/griffe2md/)\n[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#griffe2md:gitter.im)\n\nOutput API docs to Markdown using Griffe.\n\n## Installation\n\n```bash\npip install griffe2md\n```\n\nWith [`uv`](https://docs.astral.sh/uv/):\n\n```bash\nuv tool install griffe2md\n```\n\n## Usage\n\nSimply call `griffe2md` with a package name, or the path to a package folder:\n\n```bash\ngriffe2md markdown\ngriffe2md path/to/my/src/package\n```\n\nUse the `-o`, `--output` option to write to a file instead of standard output:\n\n```bash\ngriffe2md markdown -o markdown.md\n```\n\n`griffe2md` can be configured in either `pyproject.toml` or a `griffe2md.toml` file. The latter can be placed in a `.config` or `config` directory in the project root.\n\n`griffe2md.toml` file is structured as a simple key-value dictionary, e.g.:\n\n```toml\ndocstring_style = \"sphinx\"\n```\n\nIf you configure it in `pyproject.toml`, the configuration should go under the `tool.griffe2md` key:\n\n```toml\n[tool.griffe2md]\ndocstring_style = \"sphinx\"\n```\n\nSee [the documentation](https://mkdocstrings.github.io/griffe2md/reference/griffe2md/config/#griffe2md.config.ConfigDict) for reference.\n\n## Sponsors\n\n\u003c!-- sponsors-start --\u003e\n\n\u003cdiv id=\"premium-sponsors\" style=\"text-align: center;\"\u003e\n\n\u003cdiv id=\"silver-sponsors\"\u003e\u003cb\u003eSilver sponsors\u003c/b\u003e\u003cp\u003e\n\u003ca href=\"https://fastapi.tiangolo.com/\"\u003e\u003cimg alt=\"FastAPI\" src=\"https://raw.githubusercontent.com/tiangolo/fastapi/master/docs/en/docs/img/logo-margin/logo-teal.png\" style=\"height: 200px; \"\u003e\u003c/a\u003e\u003cbr\u003e\n\u003c/p\u003e\u003c/div\u003e\n\n\u003cdiv id=\"bronze-sponsors\"\u003e\u003cb\u003eBronze sponsors\u003c/b\u003e\u003cp\u003e\n\u003ca href=\"https://www.nixtla.io/\"\u003e\u003cpicture\u003e\u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://www.nixtla.io/img/logo/full-black.svg\"\u003e\u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://www.nixtla.io/img/logo/full-white.svg\"\u003e\u003cimg alt=\"Nixtla\" src=\"https://www.nixtla.io/img/logo/full-black.svg\" style=\"height: 60px; \"\u003e\u003c/picture\u003e\u003c/a\u003e\u003cbr\u003e\n\u003c/p\u003e\u003c/div\u003e\n\u003c/div\u003e\n\n---\n\n\u003cdiv id=\"sponsors\"\u003e\u003cp\u003e\n\u003ca href=\"https://github.com/ofek\"\u003e\u003cimg alt=\"ofek\" src=\"https://avatars.githubusercontent.com/u/9677399?u=386c330f212ce467ce7119d9615c75d0e9b9f1ce\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/samuelcolvin\"\u003e\u003cimg alt=\"samuelcolvin\" src=\"https://avatars.githubusercontent.com/u/4039449?u=42eb3b833047c8c4b4f647a031eaef148c16d93f\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/tlambert03\"\u003e\u003cimg alt=\"tlambert03\" src=\"https://avatars.githubusercontent.com/u/1609449?u=922abf0524b47739b37095e553c99488814b05db\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/ssbarnea\"\u003e\u003cimg alt=\"ssbarnea\" src=\"https://avatars.githubusercontent.com/u/102495?u=c7bd9ddf127785286fc939dd18cb02db0a453bce\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/femtomc\"\u003e\u003cimg alt=\"femtomc\" src=\"https://avatars.githubusercontent.com/u/34410036?u=f13a71daf2a9f0d2da189beaa94250daa629e2d8\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/cmarqu\"\u003e\u003cimg alt=\"cmarqu\" src=\"https://avatars.githubusercontent.com/u/360986?v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/kolenaIO\"\u003e\u003cimg alt=\"kolenaIO\" src=\"https://avatars.githubusercontent.com/u/77010818?v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/ramnes\"\u003e\u003cimg alt=\"ramnes\" src=\"https://avatars.githubusercontent.com/u/835072?u=3fca03c3ba0051e2eb652b1def2188a94d1e1dc2\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/machow\"\u003e\u003cimg alt=\"machow\" src=\"https://avatars.githubusercontent.com/u/2574498?u=c41e3d2f758a05102d8075e38d67b9c17d4189d7\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/BenHammersley\"\u003e\u003cimg alt=\"BenHammersley\" src=\"https://avatars.githubusercontent.com/u/99436?u=4499a7b507541045222ee28ae122dbe3c8d08ab5\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/trevorWieland\"\u003e\u003cimg alt=\"trevorWieland\" src=\"https://avatars.githubusercontent.com/u/28811461?u=74cc0e3756c1d4e3d66b5c396e1d131ea8a10472\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/MarcoGorelli\"\u003e\u003cimg alt=\"MarcoGorelli\" src=\"https://avatars.githubusercontent.com/u/33491632?u=7de3a749cac76a60baca9777baf71d043a4f884d\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/analog-cbarber\"\u003e\u003cimg alt=\"analog-cbarber\" src=\"https://avatars.githubusercontent.com/u/7408243?u=642fc2bdcc9904089c62fe5aec4e03ace32da67d\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/OdinManiac\"\u003e\u003cimg alt=\"OdinManiac\" src=\"https://avatars.githubusercontent.com/u/22727172?u=36ab20970f7f52ae8e7eb67b7fcf491fee01ac22\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/rstudio-sponsorship\"\u003e\u003cimg alt=\"rstudio-sponsorship\" src=\"https://avatars.githubusercontent.com/u/58949051?u=0c471515dd18111be30dfb7669ed5e778970959b\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/schlich\"\u003e\u003cimg alt=\"schlich\" src=\"https://avatars.githubusercontent.com/u/21191435?u=6f1240adb68f21614d809ae52d66509f46b1e877\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/butterlyn\"\u003e\u003cimg alt=\"butterlyn\" src=\"https://avatars.githubusercontent.com/u/53323535?v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/livingbio\"\u003e\u003cimg alt=\"livingbio\" src=\"https://avatars.githubusercontent.com/u/10329983?v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/NemetschekAllplan\"\u003e\u003cimg alt=\"NemetschekAllplan\" src=\"https://avatars.githubusercontent.com/u/912034?v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/EricJayHartman\"\u003e\u003cimg alt=\"EricJayHartman\" src=\"https://avatars.githubusercontent.com/u/9259499?u=7e58cc7ec0cd3e85b27aec33656aa0f6612706dd\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/15r10nk\"\u003e\u003cimg alt=\"15r10nk\" src=\"https://avatars.githubusercontent.com/u/44680962?u=f04826446ff165742efa81e314bd03bf1724d50e\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/activeloopai\"\u003e\u003cimg alt=\"activeloopai\" src=\"https://avatars.githubusercontent.com/u/34816118?v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/roboflow\"\u003e\u003cimg alt=\"roboflow\" src=\"https://avatars.githubusercontent.com/u/53104118?v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/cmclaughlin\"\u003e\u003cimg alt=\"cmclaughlin\" src=\"https://avatars.githubusercontent.com/u/1061109?u=ddf6eec0edd2d11c980f8c3aa96e3d044d4e0468\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/blaisep\"\u003e\u003cimg alt=\"blaisep\" src=\"https://avatars.githubusercontent.com/u/254456?u=97d584b7c0a6faf583aa59975df4f993f671d121\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/RapidataAI\"\u003e\u003cimg alt=\"RapidataAI\" src=\"https://avatars.githubusercontent.com/u/104209891?v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/rodolphebarbanneau\"\u003e\u003cimg alt=\"rodolphebarbanneau\" src=\"https://avatars.githubusercontent.com/u/46493454?u=6c405452a40c231cdf0b68e97544e07ee956a733\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/theSymbolSyndicate\"\u003e\u003cimg alt=\"theSymbolSyndicate\" src=\"https://avatars.githubusercontent.com/u/111542255?v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/blakeNaccarato\"\u003e\u003cimg alt=\"blakeNaccarato\" src=\"https://avatars.githubusercontent.com/u/20692450?u=bb919218be30cfa994514f4cf39bb2f7cf952df4\u0026v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/ChargeStorm\"\u003e\u003cimg alt=\"ChargeStorm\" src=\"https://avatars.githubusercontent.com/u/26000165?v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/Alphadelta14\"\u003e\u003cimg alt=\"Alphadelta14\" src=\"https://avatars.githubusercontent.com/u/480845?v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/Cusp-AI\"\u003e\u003cimg alt=\"Cusp-AI\" src=\"https://avatars.githubusercontent.com/u/178170649?v=4\" style=\"height: 32px; border-radius: 100%;\"\u003e\u003c/a\u003e\n\u003c/p\u003e\u003c/div\u003e\n\n\n*And 7 more private sponsor(s).*\n\n\u003c!-- sponsors-end --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fgriffe2md","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdocstrings%2Fgriffe2md","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocstrings%2Fgriffe2md/lists"}