Automatically generate sitemaps & keep it updated as you add, remove or modify files.
Usage
Generating a new sitemap
Open your website's workspace / folder in VSCode.
Run the command Sitemap-Generator: New Sitemap
Select where to save the sitemap, select your prefered protocol and enter your domain name.
A sitemap will be generated & a new settings file named sitemap-generator.json will appear under the .vscode folder.
If you want to tweak the settings of the sitemap you can open sitemap-generator.json either manually or by running the command Sitemap-Generator: Open Settings (JSON).
By default the sitemap will automatically be updated as you add, remove or modify files (this can be turned off in the sitemap-generator.json).
Commands
Command Name
Description
Sitemap-Generator: New Sitemap
Creates a new sitemap based on a few user inputs
Sitemap-Generator: Re-Generate Sitemap
Re-Generate an already existing sitemap
Sitemap-Generator: Open Settings (JSON)
Opens the sitemap-generator.json settings file
Options
When a new sitemap is created, a sitemap-generator.json file will be created under .vscode in the current workspace.
This file includes some tweakable settings to make format the sitemap as you want it.
Key
Type
Default Value
Description
Protocol
http | https
"http"
The protocol to be used, can be either http or https
DomainName
string
"example.com"
The name of your domain e.g. "example.com"
Root
string
"./"
The relative path from the workspace to the website root where it should search for files
IncludeExt
string[]
[".html", ".php"]
List of file extentions to count as urls. e.g. ".html"
Exclude
string[]
[]
List of glob patterns to be excluded from the sitemap
TagsToInclude
string[]
["priority", "lastmod"]
Tags to be included in the sitemap. Valid values are: "priority", "lastmod", "changefreq"
DefaultChangeFrequency
string
"montly"
The default value to be added into changefreq xml tags when a new page is added
TabCharacters
string
"\t"
Character(s) to be used as tabs in the generated sitemap
bRemoveFileExtentions
boolean
false
Remove file extentions from the url
bIncludeWWW
boolean
true
If the url should include "www." or not
bUseTrailingSlash
boolean
false
Should url's end with a trailing forward slash
bAutomaticallyUpdateSitemap
boolean
true
Will automatically keep the sitemap updated when modifying files
bMinimized
boolean
false
Remove all whitespaces characters from the generated file to minimize the filesize
