Library for sitemap rendering and validation.
Library for sitemap rendering and validation.
Default output path resolver
Default output path resolver
(gzipped? path)
(need-siteindex? url-entries)
(render-siteindex sitemap-paths)
Render sitemap index XML for the sitemap-paths
, returned as a string.
Render sitemap index XML for the `sitemap-paths`, returned as a string.
(render-sitemap url-entries)
Render Clojure data structures to a String of sitemap XML.
Render Clojure data structures to a String of sitemap XML.
(render-sitemap* url-entries)
Render Clojure data structures to a seq of sitemap XMLs, chunked at the maximum sitemap size (50,000).
Render Clojure data structures to a seq of sitemap XMLs, chunked at the maximum sitemap size (50,000).
(render-sitemap-and-save path url-entries)
Render Clojure data structures to a string of sitemap XML and save it to file. Does not check whether the number of url-entries is greater than allowed.
Render Clojure data structures to a string of sitemap XML and save it to file. Does not check whether the number of url-entries is greater than allowed.
(render-sitemap-and-save* root-uri basename url-entries)
(render-sitemap-and-save*
root-uri
basename
url-entries
{:keys [output-path-resolver gzip?]
:or {output-path-resolver default-output-path-resolver gzip? false}
:as opts})
Render Clojure data structures to sitemap XML, emitting a sitemap index with sitemap chunks when the number of url-entries is greater than permitted for a single sitemap (50,000). The output file name(s) will be based on the basename.
Return sitemaps and siteindex output-path record.
Example: (render-sitemap-and-save* "https://example.com" "dir/sitemap" url-entries) will emit dir/sitemap.xml when count(url-entries) <= 50,000, otherwise will emit dir/sitemap.xml (index, pointing to https://example.com/sitemap-0.xml and so on), dir/sitemap-0.xml, dir/sitemap-1.xml, and so on.
Render Clojure data structures to sitemap XML, emitting a sitemap index with sitemap chunks when the number of url-entries is greater than permitted for a single sitemap (50,000). The output file name(s) will be based on the basename. Return sitemaps and siteindex output-path record. Example: (render-sitemap-and-save* "https://example.com" "dir/sitemap" url-entries) will emit dir/sitemap.xml when count(url-entries) <= 50,000, otherwise will emit dir/sitemap.xml (index, pointing to https://example.com/sitemap-0.xml and so on), dir/sitemap-0.xml, dir/sitemap-1.xml, and so on.
(save-sitemap f sitemap-xml)
(chunk-path _ basename i)
Returns the output path for a sitemap 'chunk' (a sub-sitemap of a sitemap index) with index i.
Returns the output path for a sitemap 'chunk' (a sub-sitemap of a sitemap index) with index i.
(index-path _ basename)
Returns the output path for a sitemap or sitemap index.
Returns the output path for a sitemap or sitemap index.
(url-entry {:keys [loc lastmod changefreq priority] :as entry})
(urlset entries)
(validate-sitemap {:keys [:siteindex :sitemaps] :as sitemap-record})
Validate a that contains an XML sitemap against the sitemaps.org schema and return a list of validation errors. If the Sitemap is valid then the list will be empty. If the XML is structurally invalid then throws SAXParseException.
Validate a that contains an XML sitemap against the sitemaps.org schema and return a list of validation errors. If the Sitemap is valid then the list will be empty. If the XML is structurally invalid then throws SAXParseException.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close