Liking cljdoc? Tell your friends :D

code.doc.executive


*default-base*clj


*default-deploy*clj


*default-include*clj


*template-path*clj


all-pagesclj

(all-pages {:keys [publish]})

finds and creates entries for all documents

(-> (all-pages {:publish (config/load "config/code.doc.edn")}) keys sort vec)

finds and creates entries for all documents

(-> (all-pages {:publish (config/load "config/code.doc.edn")})
    keys
    sort
   vec)
raw docstring

deploy-templateclj

(deploy-template site params lookup {:keys [root]})

copies all assets in the template folder to output

(deploy-template "hara" {:print {:function true}} (all-sites {:root "."}) {:root "."})

copies all assets in the template folder to output

(deploy-template "hara"
                 {:print {:function true}}
                (all-sites {:root "."})
                 {:root "."})
raw docstring

init-templateclj

(init-template site params lookup {:keys [root]})

initialises template for customisation and deployment

(init-template "spirit" {:write true} (all-sites {:root "."}) {:root "."})

initialises template for customisation and deployment

(init-template "spirit"
               {:write true}
              (all-sites {:root "."})
               {:root "."})
raw docstring

load-themeclj

(load-theme theme)

loads a theme to provide the renderer

(load-theme "bolton") => (contains {:engine "winterfell", :resource "theme/bolton", :copy ["assets"], :render map?, :manifest sequential?})

loads a theme to provide the renderer

(load-theme "bolton")
=> (contains {:engine "winterfell",
              :resource "theme/bolton",
              :copy ["assets"],
              :render map?,
              :manifest sequential?})
raw docstring

load-varclj

(load-var ns var)

loads a var, automatically requires and loads the given namespace

(load-var "clojure.core" "apply") => fn?

loads a var, automatically requires and loads the given namespace

(load-var "clojure.core" "apply")
=> fn?
raw docstring

renderclj

(render key {:keys [write full skip] :as params} lookup project)

renders .clj file to html

(let [project (publish/make-project) lookup (all-pages project)] (render 'hara/index {:write false} lookup project)) => (contains {:path string? :updated boolean? :time number?})

renders .clj file to html

(let [project (publish/make-project)
      lookup  (all-pages project)]
  (render 'hara/index {:write false} lookup project))
=> (contains {:path string?
              :updated boolean?
              :time number?})
raw docstring

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

× close