Skip to content

Commit

Permalink
doc: syntax highlighting
Browse files Browse the repository at this point in the history
  • Loading branch information
harlan-zw committed Nov 3, 2024
1 parent fd4d031 commit 37a2d5e
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
24 changes: 12 additions & 12 deletions docs/content/4.api/0.config.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ description: Configure the sitemap module.

## `enabled`

- Type: `boolean`
- Default: `true`
- Type: `boolean`{lang="ts"}
- Default: `true`{lang="ts"}

Whether to generate the sitemap.

## `sortEntries`

- Type: `boolean`
- Default: `true`
- Type: `boolean`{lang="ts"}
- Default: `true`{lang="ts"}

Whether the sitemap entries should be sorted or be shown in the order they were added.

Expand All @@ -22,31 +22,31 @@ count and then alphabetically using `String.localeCompare` to ensure numbers are

## `sources`

- Type: `SitemapSource[]`
- Default: `[]`
- Type: `SitemapSource[]`{lang="ts"}
- Default: `[]`{lang="ts"}

The sources to use for the sitemap. See [Data Sources](/docs/sitemap/getting-started/data-sources) and [Dynamic URL Endpoint](/docs/sitemap/guides/dynamic-urls) for details.

## `excludeAppSources`

- Type: `boolean|AppSourceId[]`
- Default: `false`
- Type: `boolean|AppSourceId[]`{lang="ts"}
- Default: `false`{lang="ts"}

Whether to exclude [app sources](/docs/sitemap/getting-started/data-sources) from the sitemap.

## `appendSitemaps`

- Type: `(string | { sitemap: string, lastmod?: Date })[]`
- Default: `false`
- Type: `(string | { sitemap: string, lastmod?: Date })[]`{lang="ts"}
- Default: `false`{lang="ts"}

Sitemaps to append to the sitemap index.

This will only do anything when using multiple sitemaps.

## `autoLastmod`

- Type: `boolean`
- Default: `false`
- Type: `boolean`{lang="ts"}
- Default: `false`{lang="ts"}

Whether to automatically detect the `lastmod` date for each URL.
If the `lastmod` date can't be inferred from a route page file it will use the current Date.
Expand Down
16 changes: 8 additions & 8 deletions docs/content/5.releases/8.v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ Can be ran in both Nitro (runtime) and Nuxt (prerendering).

### Individual multi-sitemap API endpoints `dynamicUrlsApiEndpoint`

- Type: `boolean | string`
- Default: `false`
- Type: `boolean | string`{lang="ts"}
- Default: `false`{lang="ts"}

You can now give each sitemap a unique API endpoint to fetch URLs from.

Expand All @@ -118,8 +118,8 @@ export default defineNuxtConfig({

### New Config: `strictNuxtContentPaths`

- Type: `boolean`
- Default: `false`
- Type: `boolean`{lang="ts"}
- Default: `false`{lang="ts"}

Enable when the paths of your nuxt/content md files match the routing.

Expand All @@ -129,15 +129,15 @@ This is similar behaviour to using `nuxt/content` with `documentDriven: true`.

### New Config: `credits`

- Type: `boolean`
- Default: `true`
- Type: `boolean`{lang="ts"}
- Default: `true`{lang="ts"}

Allows you to remove the "Generate by Nuxt Sitemap" comment from the generated sitemap.

### New Config: `xslTips`

- Type: `boolean`
- Default: `true`
- Type: `boolean`{lang="ts"}
- Default: `true`{lang="ts"}

Toggle the tips displayed on the sitemap.xml pages.

Expand Down

0 comments on commit 37a2d5e

Please sign in to comment.