Liking cljdoc? Tell your friends :D

lucid.publish.prepare


lookup-metaclj

(lookup-meta key lookup project)

takes a key and looks up the associated meta information (lookup-meta "index" (publish/add-lookup (project/project)) (project/project)) => {:template "home.html" :input "test/documentation/home_lucidity.clj" :title "lucidity" :subtitle "tools for code clarity" :name "index"}

takes a key and looks up the associated meta information
(lookup-meta "index"
             (publish/add-lookup (project/project))
             (project/project))
=> {:template "home.html"
    :input "test/documentation/home_lucidity.clj"
    :title "lucidity"
    :subtitle "tools for code clarity"
   :name "index"}
raw docstring

prepareclj

(prepare inputs)
(prepare inputs {:keys [lookup] :as project})

prepares an interim structure for many inputs

prepares an interim structure for many inputs
raw docstring

prepare-singleclj

(prepare-single opts)
(prepare-single {:keys [name input] :as meta} project out)

processes a single meta to generate an interim structure

(prepare-single (lookup-meta "index" (publish/add-lookup (project/project)) (project/project)))

=> (contains-in {:articles {"index" map?}, :global map? :namespaces map? :anchors-lu {"index" map?}, :anchors {"index" map?}})

processes a single meta to generate an interim structure

(prepare-single (lookup-meta "index"
                             (publish/add-lookup (project/project))
                             (project/project)))

=> (contains-in {:articles {"index" map?},
                 :global map?
                 :namespaces map?
                 :anchors-lu {"index" map?},
                :anchors {"index" map?}})
raw docstring

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

× close