https://github.com/karmaniverous/typedoc-plugin-sitemap
Automagically generate a sitemap for your TypeDoc documentation site!
https://github.com/karmaniverous/typedoc-plugin-sitemap
sitemap typedoc-plugin
Last synced: 5 months ago
JSON representation
Automagically generate a sitemap for your TypeDoc documentation site!
- Host: GitHub
- URL: https://github.com/karmaniverous/typedoc-plugin-sitemap
- Owner: karmaniverous
- Created: 2024-11-13T14:30:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-18T16:20:46.000Z (over 1 year ago)
- Last Synced: 2025-10-24T21:55:09.962Z (8 months ago)
- Topics: sitemap, typedoc-plugin
- Language: TypeScript
- Homepage: https://docs.karmanivero.us/typedoc-plugin-sitemap/
- Size: 731 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
Awesome Lists containing this project
README
> **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.
> [API Documentation](https://karmaniverous.github.io/typedoc-plugin-sitemap) • [CHANGELOG](https://github.com/karmaniverous/typedoc-plugin-sitemap/tree/main/CHANGELOG.md)
# TypeDoc Sitemap Plugin
Automagically generate a sitemap for your [TypeDoc](https://typedoc.org/) documentation site!
To install:
```bash
npm install -D @karmaniverous/typedoc-plugin-sitemap
```
In your `typedoc.json` configuration file, add the following:
```json
{
"plugins": ["@karmaniverous/typedoc-plugin-sitemap"],
"sitemap": {
"baseUrl": "https://docs.karmanivero.us/typedoc-plugin-sitemap",
"filename": "sitemap.xml",
"changeFreq": "weekly",
"priority": 0.5
}
}
```
Now run [TypeDoc](https://typedoc.org/) however you usually run it, and your site map will be generated in the root of your output directory!
## Options
| Option | Type | Default | Description |
| ------------ | --------------------------------------------------------------------------- | --------------- | ------------------------------------------------------------- |
| `baseUrl` | `string` | _required_ | The base URL of your documentation site. |
| `filename` | `string` | `'sitemap.xml'` | The name of the sitemap file. |
| `changeFreq` | `'always' ⏐ 'hourly' ⏐ 'daily' ⏐ 'weekly' ⏐ 'monthly' ⏐ 'yearly' ⏐ 'never'` | `'weekly'` | How frequently the page is likely to change. |
| `priority` | `number` | `0.5` | The priority of this URL relative to other URLs on your site. |
---
Built for you with ❤️ on Bali! Find more great tools & templates on [my GitHub Profile](https://github.com/karmaniverous).