Liking cljdoc? Tell your friends :D

nuzzle.config


create-get-configclj

(create-get-config config)

Create the helper function get-config from the transformed config. This function takes a config key and returns the corresponding value with added key :nuzzle/get-config with value get-config function attached.

Create the helper function get-config from the transformed config. This
function takes a config key and returns the corresponding value with added
key :nuzzle/get-config with value get-config function attached.
raw docstring

create-hierarchical-index-page-entriesclj

(create-hierarchical-index-page-entries config)

Create config page entries for pages that are hierarchically located 'above' the page entries present in the config according to their path such that all pages have parent pages going up to the root page

Create config page entries for pages that are hierarchically located 'above'
the page entries present in the config according to their path such that all
pages have parent pages going up to the root page
raw docstring

create-site-indexclj

(create-site-index {:nuzzle/keys [render-page] :as config} & {:keys [lazy?]})

Creates a map where the keys are relative URLs and the values are a string of HTML or a function that produces a string of HTML. This datastructure is defined by stasis.

Creates a map where the keys are relative URLs and the values are a string
of HTML or a function that produces a string of HTML. This datastructure is
defined by stasis.
raw docstring

create-tag-index-page-entriesclj

(create-tag-index-page-entries config)

Add config page entries for pages that index all the pages which are tagged with a particular tag. Each one of these tag index pages goes under the /tags/ subdirectory

Add config page entries for pages that index all the pages which are tagged
with a particular tag. Each one of these tag index pages goes under the
/tags/ subdirectory
raw docstring

load-config-from-pathclj

(load-config-from-path config-path & {:as config-overrides})

Read a config EDN file and validate it.

Read a config EDN file and validate it.
raw docstring

load-default-configclj

(load-default-config & {:as config-overrides})

read-config-from-pathclj

(read-config-from-path config-path)

Read the config from EDN file

Read the config from EDN file
raw docstring

read-default-configclj

(read-default-config)

transform-configclj

(transform-config {:nuzzle/keys [build-drafts?] :as config})

Creates fully transformed config with or without drafts.

Creates fully transformed config with or without drafts.
raw docstring

validate-configclj

(validate-config config)

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

× close