//sitemap-tsbyuserquin
sitemap-ts
Sitemap generator.
This plugin scans your dist folder to generate sitemap.xml and robots.txt files.
Configuration options
hostname
- undefinedType:
string - undefinedDefault:
'http://localhost/'
Base URI.
dynamicRoutes
- undefinedType:
string[] - undefinedDefault:
[]
Array of strings with manual routes.
const names = [
'John',
'Bryce',
'Addison',
'Dana',
]
const dynamicRoutes = names.map(name => `/names/${name}`)
generateSitemap({ dynamicRoutes })
exclude
- undefinedType:
string[] - undefinedDefault:
[]
Array of strings with excluded routes.
generateSitemap({
exclude: ['/admin', '/private']
})
externalSitemaps
- undefinedType:
string[] - undefinedDefault:
[]
Array of strings with other sitemaps paths or urls.
generateSitemap({
externalSitemaps: ['sitemap_1', 'sitemap_2', 'subpath/sitemap_3', 'https://site.com/sitemap.xml']
})
base path
- undefinedType:
string - undefinedDefault: ``
String with base path.
generateSitemap({
basePath: '/path'
})
outDir
- undefinedType:
string - undefinedDefault:
'dist'
Output directory.
extensions
- undefinedType:
string | string[] - undefinedDefault:
'html'
File extensions that need to be generated.
Example: [‘html’, ‘md’]
changefreq
- undefinedType:
string | RoutesOptionMap<string> - undefinedDefault:
'daily'
Change frequency option for sitemap.
priority
- undefinedType:
number | RoutesOptionMap<number> - undefinedDefault:
1
Priority option for sitemap.
lastmod
- undefinedType:
Date | RoutesOptionMap<Date> - undefinedDefault:
new Date()
Last modification option for sitemap.
RoutesOptionMap<Type>
- undefinedType:
{ [route: string]: Type }
Used for changing changefreq, priority, or lastmod on a by-route level.
The (optional) route '*' is used as default.
readable
- undefinedType:
boolean - undefinedDefault:
false
Converts XML into a human-readable format
i18n
- undefinedType:
{ defaultLanguage?: string, languages: string[], strategy?: 'suffix' | 'prefix' } - undefinedDefault:
undefined, strategy: 'suffix'
Add i18n support defining alternate links.
defaultLanguage will use this language with / and languages with /language.
strategy specifies if the language code is a suffix to the path or a prefix. ‘suffix’ is default. Example: http://localhost/mypage/en or http://localhost/en/mypage
generateRobotsTxt
- undefinedType:
boolean - undefinedDefault:
true
Enables robots.txt file generation
xmlns
- undefinedType:
NSArgs - undefinedDefault:
undefined
Trim the xml namespace
See https://www.npmjs.com/package/sitemap#options-you-can-pass
Type: https://github.com/ekalinin/sitemap.js/blob/0af656e6a4a7b1403c9b3af23603261bd9cf94d3/lib/sitemap-stream.ts#L20
robots
- undefinedType:
RobotOption[] - undefinedDefault:
[{ userAgent: '*', allow: '/' }]
RobotOption:
- undefineduserAgent:
string - undefinedallow?:
string | string[] - undefineddisallow?:
string | string[] - undefinedcrawlDelay?:
number - undefinedcleanParam?:
string