(add-lookup project)
adds a namespace to file lookup table if not existing
adds a namespace to file lookup table if not existing
(copy-assets)
(copy-assets settings project)
copies all theme assets into the output directory
;; copies theme using the :copy
key into an output directory
(copy-assets)
copies all theme assets into the output directory ;; copies theme using the `:copy` key into an output directory (copy-assets)
(deploy)
(deploy settings project)
deploys theme into template directory
;; deploys the stark theme to the template/stark directory ;; overwriting any content in the directory (deploy (load-settings "stark" (project/project)) (project/project))
deploys theme into template directory ;; deploys the stark theme to the template/stark directory ;; overwriting any content in the directory (deploy (load-settings "stark" (project/project)) (project/project))
(load-settings)
(load-settings opts project)
copies all theme assets into the output directory
;; {:email "z@caudate.me", :date "06 October 2016" ...} (load-settings)
copies all theme assets into the output directory ;; {:email "z@caudate.me", :date "06 October 2016" ...} (load-settings)
(output-path project)
creates a path representing where the output files will go
creates a path representing where the output files will go
(publish)
(publish x)
(publish inputs opts project)
publishes a document as an html
;; publishes the index
entry in project.clj
(publish "index")
;; publishes index
in a specific project with additional options
(publish "index"
{:refresh true :theme "bolton"}
(project/project <PATH>))
publishes a document as an html ;; publishes the `index` entry in `project.clj` (publish "index") ;; publishes `index` in a specific project with additional options (publish "index" {:refresh true :theme "bolton"} (project/project <PATH>))
(publish-all)
(publish-all opts project)
publishes all documents as html
;; publishes all the entries in :publish :files
(publish-all)
;; publishes all entries in a specific project (publish-all {:refresh true :theme "bolton"} (project/project <PATH>))
publishes all documents as html ;; publishes all the entries in `:publish :files` (publish-all) ;; publishes all entries in a specific project (publish-all {:refresh true :theme "bolton"} (project/project <PATH>))
(unwatch)
(unwatch {:keys [root] :as project})
removes the automatic publishing of documentation files
(unwatch)
removes the automatic publishing of documentation files (unwatch)
(watch)
(watch opts {:keys [root] :as project})
automatic publishing of documentation files
(watch)
automatic publishing of documentation files (watch)
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close