{"id":14959180,"url":"https://github.com/hideoo/generator-starlight-plugin","last_synced_at":"2025-08-24T01:11:13.379Z","repository":{"id":255439220,"uuid":"850284164","full_name":"HiDeoo/generator-starlight-plugin","owner":"HiDeoo","description":"Yeoman generator for Starlight plugins","archived":false,"fork":false,"pushed_at":"2025-05-17T11:50:01.000Z","size":366,"stargazers_count":15,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-10T15:45:30.041Z","etag":null,"topics":["astro","documentation","plugin","starlight","yeoman-generator"],"latest_commit_sha":null,"homepage":"","language":"MDX","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/HiDeoo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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-08-31T11:04:58.000Z","updated_at":"2025-05-20T00:14:26.000Z","dependencies_parsed_at":"2025-03-12T17:21:24.743Z","dependency_job_id":"5d25a47e-fb81-4363-b200-6f1204209259","html_url":"https://github.com/HiDeoo/generator-starlight-plugin","commit_stats":null,"previous_names":["hideoo/generator-starlight-plugin"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/HiDeoo/generator-starlight-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2Fgenerator-starlight-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2Fgenerator-starlight-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2Fgenerator-starlight-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2Fgenerator-starlight-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HiDeoo","download_url":"https://codeload.github.com/HiDeoo/generator-starlight-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HiDeoo%2Fgenerator-starlight-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271778236,"owners_count":24819265,"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","status":"online","status_checked_at":"2025-08-23T02:00:09.327Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["astro","documentation","plugin","starlight","yeoman-generator"],"created_at":"2024-09-24T13:19:03.728Z","updated_at":"2025-08-24T01:11:13.352Z","avatar_url":"https://github.com/HiDeoo.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003egenerator-starlight-plugin 🔋\u003c/h1\u003e\n  \u003cp\u003eYeoman generator for Starlight plugins.\u003c/p\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/HiDeoo/generator-starlight-plugin/actions/workflows/integration.yml\"\u003e\n    \u003cimg alt=\"Integration Status\" src=\"https://github.com/HiDeoo/generator-starlight-plugin/actions/workflows/integration.yml/badge.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/HiDeoo/generator-starlight-plugin/blob/main/LICENSE\"\u003e\n    \u003cimg alt=\"License\" src=\"https://badgen.net/github/license/HiDeoo/generator-starlight-plugin\" /\u003e\n  \u003c/a\u003e\n  \u003cbr /\u003e\n\u003c/div\u003e\n\n## Features\n\nAn **opinionated** but still **lightweight** Yeoman generator to help create Starlight plugins.\n\n- **opinionated**: [Git](https://git-scm.com/) and [pnpm](https://pnpm.io/) are required to generate a monorepo containing a Starlight plugin package and a Starlight documentation project acting at the same time as a playground to test your plugin. The plugin is expected to be written in TypeScript, hosted on GitHub, and licensed under the MIT license.\n- **lightweight**: Formatting, linting, testing, bundling, publishing, deploying the documentation, which are all optional for a Starlight plugin, are not enforced by the generator. You are free to add them to your project as you see fit using the tools and services you prefer.\n\n## Usage\n\nTo use the generator, run the following command in your terminal from the directory where you want to work on your plugin:\n\n```shell\nnpx -p yo -p @hideoo/generator-starlight-plugin -- yo @hideoo/starlight-plugin\n```\n\nTo start creating your Starlight plugin, edit the `packages/plugin-name/index.ts` file which will be the entry point of your plugin.\n\nTo test your plugin, run the following command from the `docs/` directory:\n\n```shell\npnpm dev\n```\n\nTo learn more about plugin development, check the [Starlight documentation](https://starlight.astro.build/reference/plugins/).\n\n## Project Structure\n\nThe generated project uses a monorepo structure with different pnpm workspaces:\n\n- `docs/`: A Starlight documentation project to document your plugin that also acts as a playground to test it.\n- `packages/plugin-name/`: A package containing your Starlight plugin.\n\n## Resources\n\nThe generated project contains the bare minimum to get started with a Starlight plugin. Here are some additional resources to help you develop and release your plugin:\n\n- [Starlight Documentation](https://starlight.astro.build/)\n- [Starlight Plugins Reference](https://starlight.astro.build/reference/plugins/)\n- [Starlight Plugins Showcase](https://starlight.astro.build/resources/plugins/)\n- [Astro Documentation](https://docs.astro.build/)\n- [Astro Integration API](https://docs.astro.build/en/reference/integrations-reference/)\n- [Astro “Deploy your site” guide](https://docs.astro.build/en/guides/deploy/)\n- [Astro Discord](https://astro.build/chat/)\n- [npm Registry Publishing Guide](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry)\n\n\u003e [!TIP]\n\u003e After [deploying](https://docs.astro.build/en/guides/deploy/) your documentation, add a link to it in the `packages/plugin-name/README.md` file to help users find it.\n\n## License\n\nLicensed under the MIT License, Copyright © HiDeoo.\n\nSee [LICENSE](https://github.com/HiDeoo/generator-starlight-plugin/blob/main/LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhideoo%2Fgenerator-starlight-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhideoo%2Fgenerator-starlight-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhideoo%2Fgenerator-starlight-plugin/lists"}