Skip to content

Commit

Permalink
- Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@iamvishnusankar
iamvishnusankar committed Sep 2, 2020
1 parent 529d5f7 commit 16b1a97
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,20 +60,20 @@ Above is the minimal configuration to split a large sitemap. When the number of

## Configuration Options

| property | description | type |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- |
| siteUrl | Base url of your website | string |
| changefreq (optional) | Change frequency. Default `daily` | string |
| priority (optional) | Priority. Default `0.7` | number |
| sitemapSize(optional) | Split large sitemap into multiple files by specifying sitemap size. Default `5000` | number |
| generateRobotsTxt (optional) | Generate a `robots.txt` file and list the generated sitemaps. Default `false` | boolean |
| robotsTxtOptions.policies (optional) | Policies for generating `robots.txt`. Default `[{ userAgent: '*', allow: '/' }]` | [] |
| robotsTxtOptions.additionalSitemaps (optional) | Options to add addition sitemap to `robots.txt` host entry | string[] |
| autoLastmod (optional) | Add `<lastmod/>` property. Default `true` | true | |
| exclude (optional) | Array of **relative** paths to exclude from listing on `sitemap.xml` or `sitemap-*.xml`. e.g.: `['/page-0', '/page-4']`. Apart from this options `next-sitemap` also offers a custom `transform` option which could be used to exclude urls that match specific patterns | string[] |
| sourceDir (optional) | next.js build directory. Default `.next` | string |
| outDir (optional) | All the generated files will be exported to this directory. Default `public` | string |
| transform (optional) | A transformation function, which runs **for each** url in the sitemap. Returning `null` value from the transformation function will result in the exclusion of that specific url from the generated sitemap list. | function |
| property | description | type |
| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| siteUrl | Base url of your website | string |
| changefreq (optional) | Change frequency. Default `daily` | string |
| priority (optional) | Priority. Default `0.7` | number |
| sitemapSize(optional) | Split large sitemap into multiple files by specifying sitemap size. Default `5000` | number |
| generateRobotsTxt (optional) | Generate a `robots.txt` file and list the generated sitemaps. Default `false` | boolean |
| robotsTxtOptions.policies (optional) | Policies for generating `robots.txt`. Default `[{ userAgent: '*', allow: '/' }]` | [] |
| robotsTxtOptions.additionalSitemaps (optional) | Options to add addition sitemap to `robots.txt` host entry | string[] |
| autoLastmod (optional) | Add `<lastmod/>` property. Default `true` | true | |
| exclude (optional) | Array of **relative** paths to exclude from listing on `sitemap.xml` or `sitemap-*.xml`. e.g.: `['/page-0', '/page-4']`. Apart from this option `next-sitemap` also offers a custom `transform` option which could be used to exclude urls that match specific patterns | string[] |
| sourceDir (optional) | next.js build directory. Default `.next` | string |
| outDir (optional) | All the generated files will be exported to this directory. Default `public` | string |
| transform (optional) | A transformation function, which runs **for each** url in the sitemap. Returning `null` value from the transformation function will result in the exclusion of that specific url from the generated sitemap list. | function |

## Custom transformation function

Expand Down

0 comments on commit 16b1a97

Please sign in to comment.