{"id":20986822,"url":"https://github.com/karmaniverous/typedoc-plugin-sitemap","last_synced_at":"2026-01-31T16:33:28.363Z","repository":{"id":262670590,"uuid":"887932771","full_name":"karmaniverous/typedoc-plugin-sitemap","owner":"karmaniverous","description":"Automagically generate a sitemap for your TypeDoc documentation site!","archived":false,"fork":false,"pushed_at":"2024-11-18T16:20:46.000Z","size":749,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-24T21:55:09.962Z","etag":null,"topics":["sitemap","typedoc-plugin"],"latest_commit_sha":null,"homepage":"https://docs.karmanivero.us/typedoc-plugin-sitemap/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/karmaniverous.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":null,"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},"funding":{"github":["karmaniverous"]}},"created_at":"2024-11-13T14:30:35.000Z","updated_at":"2024-11-18T16:20:50.000Z","dependencies_parsed_at":"2025-04-12T03:52:30.975Z","dependency_job_id":"f29dc869-b8db-4625-a822-e3947a5f0a49","html_url":"https://github.com/karmaniverous/typedoc-plugin-sitemap","commit_stats":null,"previous_names":["karmaniverous/typedoc-plugin-sitemap"],"tags_count":3,"template":false,"template_full_name":"karmaniverous/npm-package-template-ts","purl":"pkg:github/karmaniverous/typedoc-plugin-sitemap","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karmaniverous%2Ftypedoc-plugin-sitemap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karmaniverous%2Ftypedoc-plugin-sitemap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karmaniverous%2Ftypedoc-plugin-sitemap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karmaniverous%2Ftypedoc-plugin-sitemap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/karmaniverous","download_url":"https://codeload.github.com/karmaniverous/typedoc-plugin-sitemap/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/karmaniverous%2Ftypedoc-plugin-sitemap/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28947654,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T14:26:55.697Z","status":"ssl_error","status_checked_at":"2026-01-31T14:26:52.545Z","response_time":128,"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":["sitemap","typedoc-plugin"],"created_at":"2024-11-19T06:15:00.233Z","updated_at":"2026-01-31T16:33:28.326Z","avatar_url":"https://github.com/karmaniverous.png","language":"TypeScript","funding_links":["https://github.com/sponsors/karmaniverous"],"categories":[],"sub_categories":[],"readme":"\u003e **PARTIALLY DEPRECATED!** Typedoc's [`hostedBaseUrl`](https://typedoc.org/options/output/#hostedbaseurl) option now generates a sitemap natively. Only use this plugin if you need more control over the sitemap generation process.\n\n\u003c!-- TYPEDOC_EXCLUDE --\u003e\n\n\u003e [API Documentation](https://karmaniverous.github.io/typedoc-plugin-sitemap) • [CHANGELOG](https://github.com/karmaniverous/typedoc-plugin-sitemap/tree/main/CHANGELOG.md)\n\n\u003c!-- /TYPEDOC_EXCLUDE --\u003e\n\n# TypeDoc Sitemap Plugin\n\nAutomagically generate a sitemap for your [TypeDoc](https://typedoc.org/) documentation site!\n\nTo install:\n\n```bash\nnpm install -D @karmaniverous/typedoc-plugin-sitemap\n```\n\nIn your `typedoc.json` configuration file, add the following:\n\n```json\n{\n  \"plugins\": [\"@karmaniverous/typedoc-plugin-sitemap\"],\n  \"sitemap\": {\n    \"baseUrl\": \"https://docs.karmanivero.us/typedoc-plugin-sitemap\",\n    \"filename\": \"sitemap.xml\",\n    \"changeFreq\": \"weekly\",\n    \"priority\": 0.5\n  }\n}\n```\n\nNow run [TypeDoc](https://typedoc.org/) however you usually run it, and your site map will be generated in the root of your output directory!\n\n## Options\n\n| Option       | Type                                                                        | Default         | Description                                                   |\n| ------------ | --------------------------------------------------------------------------- | --------------- | ------------------------------------------------------------- |\n| `baseUrl`    | `string`                                                                    | _required_      | The base URL of your documentation site.                      |\n| `filename`   | `string`                                                                    | `'sitemap.xml'` | The name of the sitemap file.                                 |\n| `changeFreq` | `'always' ⏐ 'hourly' ⏐ 'daily' ⏐ 'weekly' ⏐ 'monthly' ⏐ 'yearly' ⏐ 'never'` | `'weekly'`      | How frequently the page is likely to change.                  |\n| `priority`   | `number`                                                                    | `0.5`           | The priority of this URL relative to other URLs on your site. |\n\n---\n\nBuilt for you with ❤️ on Bali! Find more great tools \u0026 templates on [my GitHub Profile](https://github.com/karmaniverous).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarmaniverous%2Ftypedoc-plugin-sitemap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkarmaniverous%2Ftypedoc-plugin-sitemap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkarmaniverous%2Ftypedoc-plugin-sitemap/lists"}