mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
17c02925c5
* wip: config migration * fix: formatting * refactor: projectRoot -> root * refactor: pageUrlFormat -> format * refactor: buildOptions.site -> site * refactor: public -> publicDir * refactor: dist -> outDir * refactor: styleOptions -> style * fix: some dist tests -> outDir * refactor: remove legacyBuild (with TODOs) * refactor: more legacyBuild cleanup * refactor: server host and port * fix: remove experimentalStaticBuild CLI flag * refactor: src -> srcDir * refactor: devOptions.trailing -> trailing * refactor: remove sitemap + related flags * refactor: experimentalSSR -> experimental.ssr * fix: last devOptions * refactor: drafts -> markdown.drafts * fix: TS error on port as const * refactor: remove pages * refactor: more --project-root updates * refactor: markdownOptions -> markdown * fix: remaining type errors * feat: update AstroUserConfig * refactor: update CLI flag mapper + server mapper * fix: loadFixture projectRoot * fix: merge CLI flags before validating / transforming * wip: attempt to fix bad createRouteManifest config * refactor: combine config.base and config.site * fix: skip route manifest test for now * fix: site and base handling * refactor: update failing config testes * fix: build failure * feat: update config types with migration help * chore: update types * fix(deno): update deno fixture * chore: remove config migration logic * chore: remove logLevel * chore: clean-up config types * chore: update config warning * chore: add changeset * Sitemap Integration (#2965) * feat: add sitemap filter config option * feat: add canonicalURL sitemap config option * docs: update sitemap README * fix: update for new config * fix: filter not being applied * chore: changeset Co-authored-by: bholmesdev <hey@bholmes.dev> * fred pass * fix: Astro.resolve typo * fix: public => publicDir Co-authored-by: bholmesdev <hey@bholmes.dev> Co-authored-by: Fred K. Schott <fkschott@gmail.com>
115 lines
3.3 KiB
Markdown
115 lines
3.3 KiB
Markdown
# @astrojs/sitemap 🗺
|
|
|
|
This **[Astro integration][astro-integration]** generates a sitemap for your Astro project.
|
|
|
|
Sitemaps outline all of the pages, videos, and files on your site. Search engines like Google read this file to crawl your site more efficiently. [See Google's own advice on sitemaps](https://developers.google.com/search/docs/advanced/sitemaps/overview) to learn more.
|
|
|
|
## Installation
|
|
|
|
There are two ways to add integrations to your project. Let's try the most convenient option first!
|
|
|
|
### (experimental) `astro add` command
|
|
|
|
Astro includes a CLI tool for adding first party integrations: `astro add`. This command will:
|
|
1. (Optionally) Install all necessary dependencies and peer dependencies
|
|
2. (Also optionally) Update your `astro.config.*` file to apply this integration
|
|
|
|
To install `@astrojs/sitemap`, run the following from your project directory and follow the prompts:
|
|
|
|
```sh
|
|
# Using NPM
|
|
npx astro add sitemap
|
|
# Using Yarn
|
|
yarn astro add sitemap
|
|
# Using PNPM
|
|
pnpx astro add sitemap
|
|
```
|
|
|
|
If you run into any hiccups, [feel free to log an issue on our GitHub](https://github.com/withastro/astro/issues) and try the manual installation steps below.
|
|
|
|
### Install dependencies manually
|
|
|
|
First, install the `@astrojs/sitemap` integration like so:
|
|
|
|
```
|
|
npm install @astrojs/sitemap
|
|
```
|
|
|
|
Then, apply this integration to your `astro.config.*` file using the `integrations` property:
|
|
|
|
__astro.config.mjs__
|
|
|
|
```js
|
|
import sitemap from '@astrojs/sitemap';
|
|
|
|
export default {
|
|
// ...
|
|
integrations: [sitemap()],
|
|
}
|
|
```
|
|
|
|
## Getting started
|
|
|
|
`@astrojs/sitemap` requires a deployment / site URL for generation. Add your site's URL under your `astro.config.*` using the `site` property:
|
|
|
|
__astro.config.mjs__
|
|
|
|
```js
|
|
import sitemap from '@astrojs/sitemap';
|
|
|
|
export default {
|
|
// ...
|
|
site: 'https://stargazers.club',
|
|
integrations: [sitemap()],
|
|
}
|
|
```
|
|
|
|
Now, [build your site for production](https://docs.astro.build/en/reference/cli-reference/#astro-build) via the `astro build` command. You should find your sitemap under `dist/sitemap.xml`!
|
|
|
|
You can also check our [Astro Integration Documentation][astro-integration] for more on integrations.
|
|
|
|
## Configuration
|
|
|
|
### filter
|
|
|
|
All pages are included in your sitemap by default. By adding a custom `filter`, you can filter included pages by URL.
|
|
|
|
__astro.config.mjs__
|
|
|
|
```js
|
|
import sitemap from '@astrojs/sitemap';
|
|
|
|
export default {
|
|
site: 'https://stargazers.club',
|
|
integrations: [
|
|
sitemap({
|
|
filter: (page) => page !== 'https://stargazers.club/secret-vip-lounge'
|
|
}),
|
|
],
|
|
}
|
|
```
|
|
|
|
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.
|
|
|
|
### canonicalURL
|
|
|
|
If present, we use the `site` config option as the base for all sitemap URLs. Use `canonicalURL` to override this.
|
|
|
|
__astro.config.mjs__
|
|
|
|
```js
|
|
import sitemap from '@astrojs/sitemap';
|
|
|
|
export default {
|
|
site: 'https://stargazers.club',
|
|
integrations: [
|
|
sitemap({
|
|
// https://astronaut.party will be used for all sitemap URLs instead
|
|
canonicalURL: 'https://astronaut.party',
|
|
}),
|
|
],
|
|
}
|
|
```
|
|
|
|
[astro-integration]: https://docs.astro.build/en/guides/integrations-guide/
|
|
[astro-ui-frameworks]: https://docs.astro.build/en/core-concepts/framework-components/#using-framework-components
|