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

Fix: document sitemap + SSR use case (#3689)

Browse source 
* fix: offer suggestion for SSR sitemap users

* docs: add customPages to README

* chore: changeset
This commit is contained in:
Ben Holmes 2022-06-23 11:31:54 -04:00 committed by GitHub
parent 059d00bd5d
commit 3f8ee70e2b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 32 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/sixty-mirrors-bake.md Normal file
View file

@ -0,0 +1,5 @@
---
'@astrojs/sitemap': patch
---
Add warning log for sitemap + SSR adapter, with suggestion to use customPages configuration option

21
packages/integrations/sitemap/README.md
View file

@ -119,6 +119,27 @@ export default {
The `page` function parameter is the full URL of your rendered page, including your `site` domain. Return `true` to include a page in your sitemap, and `false` to remove it.
### customPages
You may have custom routes to add to your sitemap. To append these to your sitemap, pass an array of valid URLs including the base origin:
__astro.config.mjs__
```js
import sitemap from '@astrojs/sitemap';
export default {
site: 'https://stargazers.club',
integrations: [
sitemap({
customPages: ['https://stargazers.biz/careers'],
}),
],
}
```
💡 You should also use `customPages` to manually list sitemap pages when using an SSR adapter. Currently, we cannot detect your site's pages unless you are building statically. To avoid an empty sitemap, list all pages (including the base origin) with this configuration option!
### canonicalURL
If present, we use the `site` config option as the base for all sitemap URLs. Use `canonicalURL` to override this.

7
packages/integrations/sitemap/src/index.ts
View file

@ -99,7 +99,12 @@ const createPlugin = (options?: SitemapOptions): AstroIntegration => {
}
if (pageUrls.length === 0) {
logger.warn(`No data for sitemap.\n\`${OUTFILE}\` is not created.`);
// offer suggestion for SSR users
if (typeof config.adapter !== 'undefined') {
logger.warn(`No pages found! We can only detect sitemap routes for "static" projects. Since you are using an SSR adapter, we recommend manually listing your sitemap routes using the "customPages" integration option.\n\nExample: \`sitemap({ customPages: ['https://example.com/route'] })\``);
} else {
logger.warn(`No pages found!\n\`${OUTFILE}\` not created.`);
}
return;
}