{"id":22567760,"url":"https://github.com/svelte-docgen/svelte-docgen","last_synced_at":"2025-04-09T22:13:24.015Z","repository":{"id":263737340,"uuid":"888785199","full_name":"svelte-docgen/svelte-docgen","owner":"svelte-docgen","description":"Effortless documentation for Svelte components","archived":false,"fork":false,"pushed_at":"2025-02-05T03:55:54.000Z","size":10168,"stargazers_count":11,"open_issues_count":21,"forks_count":0,"subscribers_count":2,"default_branch":"next","last_synced_at":"2025-04-09T22:13:18.837Z","etag":null,"topics":["component","docgen","documentation","svelte"],"latest_commit_sha":null,"homepage":"https://svelte-docgen.pages.dev","language":"TypeScript","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/svelte-docgen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"svelte-docgen","open_collective":"svelte-docgen"}},"created_at":"2024-11-15T02:09:32.000Z","updated_at":"2025-04-04T09:39:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"30288597-85f6-46ad-bd7f-c7a307b608b9","html_url":"https://github.com/svelte-docgen/svelte-docgen","commit_stats":null,"previous_names":["xeho91/svelte-docgen","svelte-docgen/svelte-docgen"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svelte-docgen%2Fsvelte-docgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svelte-docgen%2Fsvelte-docgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svelte-docgen%2Fsvelte-docgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/svelte-docgen%2Fsvelte-docgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/svelte-docgen","download_url":"https://codeload.github.com/svelte-docgen/svelte-docgen/tar.gz/refs/heads/next","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248119292,"owners_count":21050755,"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":["component","docgen","documentation","svelte"],"created_at":"2024-12-08T00:09:04.529Z","updated_at":"2025-04-09T22:13:23.999Z","avatar_url":"https://github.com/svelte-docgen.png","language":"TypeScript","funding_links":["https://github.com/sponsors/svelte-docgen","https://opencollective.com/svelte-docgen"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg\n        alt=\"svelte-docgen logo\"\n        src=\"./assets/brand/logo.svg\"\n        width=\"180\"\n    \u003e\n    \u003cbr\u003e\n    \u003cimg\n        alt=\"GitHub Actions Workflow Status\"\n        src=\"https://img.shields.io/github/actions/workflow/status/svelte-docgen/svelte-docgen/ci.yml?branch=main\u0026style=for-the-badge\u0026logo=github\u0026label=CI\"\n    \u003e\n    \u003cimg\n        alt=\"Codecov icon\"\n        src=\"https://img.shields.io/codecov/c/github/svelte-docgen/svelte-docgen?style=for-the-badge\u0026logo=codecov\u0026link=https%3A%2F%2Fapp.codecov.io%2Fgh%2Fsvelte-docgen%2Fsvelte-docgen\"\n    \u003e\n\u003c/p\u003e\n\n# `svelte-docgen`\n\nThis project is a monorepo for [`svelte-docgen`](./packages/svelte-docgen) related packages.\n\n\u003e [!WARNING]\n\u003e This project is still a work in progress. [See roadmap for `v1`](https://github.com/svelte-docgen/svelte-docgen/issues/5).\n\n## Packages\n\n| Package                                                                                     | Description                                                                                                        |\n| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |\n| [`svelte-docgen`](./packages/svelte-docgen)                                                 | Core package                                                                                                       |\n| `@svelte-docgen/cli` [🚧 Tracking](https://github.com/svelte-docgen/svelte-docgen/issues/9) | Standalone CLI                                                                                                     |\n| [`@svelte-docgen/extractor`](./packages/extractor)                                          | Extracting types from `*.svelte` files to write your own                                                           |\n| [`@svelte-docgen/server`](./packages/server)                                                | Run a server which allows fetching docs on demand                                                                  |\n| [`vite-plugin-svelte-docgen`](./packages/vite-plugin-svelte-docgen)                         | [Vite](https://github.com/vitejs/vite) plugin which creates virtual files for your Svelte docgen data - on demand. |\n\n---\n\n## Contributing\n\nTake a look at the [contributing guide](./.github/CONTRIBUTING.md).\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.\n**Contributions of any kind are welcome!**\n\n💌 to these people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/xeho91\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/18627568?v=4?s=50\" width=\"50px;\" alt=\"Mateusz Kadlubowski\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eMateusz Kadlubowski\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/svelte-docgen/svelte-docgen/commits?author=xeho91\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#infra-xeho91\" title=\"Infrastructure (Hosting, Build-Tools, etc)\"\u003e🚇\u003c/a\u003e \u003ca href=\"#maintenance-xeho91\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://github.com/ciscorn\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/5351911?v=4?s=50\" width=\"50px;\" alt=\"Taku Fukada\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eTaku Fukada\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/svelte-docgen/svelte-docgen/commits?author=ciscorn\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#infra-ciscorn\" title=\"Infrastructure (Hosting, Build-Tools, etc)\"\u003e🚇\u003c/a\u003e \u003ca href=\"#maintenance-ciscorn\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n\u003e [!NOTE]\n\u003e We also put a lot of effort to make this project [e18e](https://e18e.dev/)-friendly.\n\n### Support\n\nIf you don't have time, but you need this project to work, or resolve an existing issue, consider [sponsorship](https://github.com/sponsors/svelte-docgen).\n\n---\n\n## Authors\n\n- Mateusz \"[xeho91](https://github.com/xeho91)\" Kadlubowski\n- Taku \"[ciscorn](https://github.com/ciscorn)\" Fukada\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsvelte-docgen%2Fsvelte-docgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsvelte-docgen%2Fsvelte-docgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsvelte-docgen%2Fsvelte-docgen/lists"}