Skip to content

Commit

Permalink
fix: Default value of sitemap option is not correct (#469)
Browse files Browse the repository at this point in the history
The current documentation explains that the default value of the sitemap option is `sitemap.xml` whereas in the code it is written `sitemap/sitemap-index.xml` (see here https://github.com/mdreizin/gatsby-plugin-robots-txt/blob/e04abbc660c611d927148840420395a93a6afe91/src/gatsby-node.js#L75).

This commit corrects this documentation error.
  • Loading branch information
oziks committed Jun 28, 2021
1 parent b548220 commit 66ccd4f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ This plugin uses [`generate-robotstxt`](https://github.com/itgalaxy/generate-rob
| Name | Type | Default | Description |
| :----------: | :--------: | :-----------------------------------: | :----------------------------------------------------------------------------: |
| `host` | `String` | `${siteMetadata.siteUrl}` | Host of your site |
| `sitemap` | `String` / `String[]` | `${siteMetadata.siteUrl}/sitemap.xml` | Path(s) to `sitemap.xml` |
| `sitemap` | `String` / `String[]` | `${siteMetadata.siteUrl}/sitemap/sitemap-index.xml` | Path(s) to `sitemap.xml` |
| `policy` | `Policy[]` | `[]` | List of [`Policy`](https://github.com/itgalaxy/generate-robotstxt#usage) rules |
| `configFile` | `String` | `undefined` | Path to external config file |
| `output` | `String` | `/robots.txt` | Path where to create the `robots.txt` |
Expand Down

0 comments on commit 66ccd4f

Please sign in to comment.