michael/astro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix sitemapFilter docs (#2762)

Browse source
This commit is contained in:
Fred K. Schott 2022-03-11 08:56:54 -08:00 committed by GitHub
parent ba68daa235
commit 6ce97b1ebe
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
packages/astro/src/@types/astro.ts
View file

@ -229,16 +229,20 @@ export interface AstroUserConfig {
/** /**
* @docs * @docs
* @name buildOptions.sitemapFilter * @name buildOptions.sitemapFilter
* @type {undefined|((page: string) => boolean)} * @typeraw {(page: string) => boolean}
* @default `undefined` * @see buildOptions.sitemap
* @description * @description
* Customize sitemap generation for your build by excluding certain pages. * By default, all pages are included in your generated sitemap.
* You can filter included pages by URL using `buildOptions.sitemapFilter`.
*
* The `page` function parameter is the full URL of your rendered page, including your `buildOptions.site` domain.
* Return `true` to include a page in your sitemap, and `false` to remove it.
* *
* ```js * ```js
* { * {
* buildOptions: { * buildOptions: {
* sitemap: true * sitemap: true
* sitemapFilter: (page) => !page.includes('secret-page') * sitemapFilter: (page) => page !== 'http://example.com/secret-page')
* } * }
* } * }
* ``` * ```