Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
JB AUBREE committed May 22, 2024
1 parent 6c6ec3e commit 32635e0
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Base URI.
- **Default:** `[]`

Array of strings with manual dynamic routes.

```js
export default {
plugins: [
Expand All @@ -72,6 +73,7 @@ export default {
- **Default:** `[]`

Array of strings with excluded routes.

```js
export default {
plugins: [
Expand All @@ -95,6 +97,7 @@ You can find a working example in example folder.
- **Default:** `[]`

Array of strings with other sitemaps paths or urls.

```js
generateSitemap({
externalSitemaps: ['sitemap_1', 'sitemap_2', 'subpath/sitemap_3', 'https://site.com/sitemap.xml']
Expand Down Expand Up @@ -143,13 +146,22 @@ Last modification option for sitemap.

Used for changing `changefreq`, `priority`, or `lastmod` on a by-route level.
The (optional) route `'*'` is used as default.

### readable

- **Type:** `boolean`
- **Default:** `false`

Converts XML into a human readable format

### i18n

- **Type:** `{ defaultLanguage?: string, languages: string[] }`
- **Default:** `undefined`

Add i18n support defining alternate links.
defaultLanguage will use this language with / and languages with /language

### generateRobotsTxt

- **Type:** `boolean`
Expand All @@ -163,6 +175,7 @@ Enables robots.txt file generation
- **Default:** `[{ userAgent: '*', allow: '/' }]`

RobotOption:

- **userAgent**: `string`
- **allow**?: `string | string[]`
- **disallow**?: `string | string[]`
Expand Down

0 comments on commit 32635e0

Please sign in to comment.