blackoutsecure/Blackout Secure Sitemap Generator

Automated XML/TXT/GZIP sitemaps for static sites and SSG frameworks

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
site_urlPublic base URL of the site, e.g., https://example.com. Required when running from other repositories.yes
public_dirDirectory containing the built site files. Defaults to dist (most common for modern build tools). Examples: dist, public, build, out, _sitenodist
sitemap_output_dirDirectory to write sitemap files (XML, TXT, GZIP). Defaults to public_dir.no
include_patternsComma-separated glob patterns to include (relative to public_dir)no**/*.html,**/*.htm
exclude_patternsComma-separated glob patterns to exclude (relative to public_dir)no**/*.map
exclude_urlsComma-separated list of URLs to exclude from sitemap (exact match or pattern)no*/sitemap*.xml,*/sitemap*.txt,*/sitemap*.xml.gz
exclude_extensionsComma-separated list of file extensions to exclude (e.g., .zip,.exe,.dmg). Note: Google can index many file types including PDFs - see https://developers.google.com/search/docs/crawling-indexing/indexable-file-typesno.zip,.exe,.dmg,.pkg,.deb,.rpm,.tar,.gz,.7z,.rar,.iso
additional_urlsComma-separated list of extra absolute URLs to includeno
gzipWhether to also emit gzip-compressed sitemap filesnotrue
lastmod_strategySource for <lastmod> tag (optional per sitemaps.org): Date of last modification in W3C Datetime format. git=git commit time | filemtime=file modification time | current=build time | none=omit tag. Note: Should reflect when the linked page was last modified, not when sitemap is generated.nogit
changefreq<changefreq> tag (optional per sitemaps.org): How frequently the page is likely to change. Valid values: always, hourly, daily, weekly, monthly, yearly, never. Note: Considered a hint, not a command to search engines.no
priority<priority> tag (optional per sitemaps.org): Priority of URLs relative to other URLs on your site. Valid values: 0.0 to 1.0 (default 0.5). Note: Only affects priority on YOUR site, not compared to other sites.no
sitemap_filenameFilename for the main sitemap (must be XML format per sitemaps.org protocol, UTF-8 encoded, max 50MB uncompressed, max 50,000 URLs)nositemap.xml
allow_autodetectEnable auto-detection of site_url/public_dir when not providednotrue
prefer_company_nameOptional company/brand name to include in logs and meta (no functional impact)no
parse_canonicalParse HTML files to use <link rel=canonical> for URL normalizationnotrue
discover_linksDiscover internal links from HTML <a href> to include pages beyond glob matchesnotrue
generate_sitemap_xmlGenerate XML format sitemap (default sitemap.xml)notrue
generate_sitemap_txtGenerate TXT format sitemap per sitemaps.org protocol: One URL per line, UTF-8 encoding, max 50,000 URLs, max 50MBnotrue
generate_sitemap_gzipGenerate gzip-compressed version of XML sitemap (sitemap.xml.gz)notrue
validate_outputRun validation: ensure sitemaps are under recommended sizenotrue
strict_validationIf true, fail the job when validation issues are found. Recommended: true for CI/CD to catch issues early.notrue
validate_sitemapsComma-separated list of paths to existing sitemaps to validate (XML, TXT, or sitemap index files). Use this to validate sitemaps without generating new ones.no
debug_list_filesDebug: List all files being processednofalse
debug_list_canonicalDebug: List all parsed canonical URLsnofalse
debug_list_urlsDebug: List all URLs included in the sitemapnofalse
debug_show_sitemapDebug: Display generated sitemap.xml contentnofalse
debug_show_sitemap_txtDebug: Display generated sitemap.txt contentnofalse
debug_show_exclusionsDebug: Display all excluded files and URLsnofalse
upload_artifactsUpload generated files as GitHub artifacts.notrue
artifact_nameName of the GitHub artifact when upload_artifacts is enablednositemap-files
artifact_retention_daysNumber of days to retain the artifact (1-90). Leave empty for default (35 days)no
namedescription
sitemap_pathPath to the generated main sitemap.xml
sitemap_index_pathPath to the generated sitemap index if splitting occurred
sitemap_txt_pathPath to the generated TXT sitemap if enabled