@karmaniverous/typedoc-plugin-sitemap NPM

PARTIALLY DEPRECATED! Typedoc's hostedBaseUrl option now generates a sitemap natively. Only use this plugin if you need more control over the sitemap generation process.

API Documentation • CHANGELOG

TypeDoc Sitemap Plugin

Automagically generate a sitemap for your TypeDoc documentation site!

To install:

npm install -D @karmaniverous/typedoc-plugin-sitemap

In your typedoc.json configuration file, add the following:

{
  "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 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.

sitemap typedoc-plugin

1 year ago

1 year ago

1 year ago