Liking cljdoc? Tell your friends :D

sitemap.core

Library for sitemap generation and validation.

Library for sitemap generation and validation.
raw docstring

*extension*clj


chunk-sizeclj


encoding-utf-8clj


generate-sitemapclj

(generate-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

generate-sitemap*clj

(generate-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

generate-sitemap-and-saveclj

(generate-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

generate-sitemap-and-save*clj

(generate-sitemap-and-save* absolute-root basename url-entries)
(generate-sitemap-and-save* absolute-root basename url-entries 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.

Example: (generate-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.

Example: (generate-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

generate-sitemap-indexclj

(generate-sitemap-index sitemap-paths)

Generates sitemap index XML for the sitemap-paths, returned as a string.

Generates sitemap index XML for the `sitemap-paths`, returned as a string.
raw docstring

path-generatorclj

Default output path generator

Default output path generator
raw docstring

save-sitemapclj

(save-sitemap f sitemap-xml)

SitemapPathGeneratorcljprotocol

chunk-pathclj

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

root-pathclj

(root-path _ basename)

Returns the output path for a sitemap or sitemap index.

Returns the output path for a sitemap or sitemap index.

validate-sitemapclj

(validate-sitemap in)

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

× close