Liking cljdoc? Tell your friends :D

sitemap.core

Library for sitemap rendering and validation.

Library for sitemap rendering and validation.

*extension*


chunk-size


default-output-path-resolver

Default output path resolver

Default output path resolver
raw docstring

encoding-utf-8


need-siteindex?

(need-siteindex? url-entries)

render-siteindex

(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.
raw docstring

render-sitemap

(render-sitemap url-entries)

Render Clojure data structures to a String of sitemap XML.

Render Clojure data structures to a String of sitemap XML.
raw docstring

render-sitemap*

(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).
raw docstring

render-sitemap-and-save

(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.
raw docstring

render-sitemap-and-save*

(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? true},
                           :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.
raw docstring

save-sitemap

(save-sitemap f sitemap-xml)

SitemapOutputPathResolverprotocol

chunk-path
(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
(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

(url-entry {:keys [loc lastmod changefreq priority], :as entry})

urlset

(urlset entries)

validate-sitemap

(validate-sitemap {:keys [:siteindex :sitemaps]})

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.
raw docstring

xml-declaration

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close