Filesystem utilities used in the generation pipeline.
Filesystem utilities used in the generation pipeline.
(clean-dir! {:keys [output-dir] :as ent})Cleans the configured output-dir. Returns unmoified entity, but interacts with the filesystem.
Cleans the configured `output-dir`. Returns unmoified `ent`ity, but interacts with the filesystem.
(copy-dir! {:keys [output-dir] :as ent} what where)Copies what to where inside of the configured output-dir. Returns unmodified entity, but interacts with the filesystem.
Copies `what` to `where` inside of the configured `output-dir`. Returns unmodified `ent`ity, but interacts with the filesystem.
(generate! entity key template & args)Transforms a part of an entity under key into an HTML page using template with extra args. Returns unmodified entity, but interacts with the filesystem.
Transforms a part of an `entity` under `key` into an HTML page using `template` with extra `args`. Returns unmodified `entity`, but interacts with the filesystem.
(generate-all! entity key template & args)Transforms a sequence of values of an entity under key into HTML pages using template with extra args. Returns entity unmodified, but interacts with the filesystem.
Transforms a sequence of values of an `entity` under `key` into HTML pages using `template` with extra `args`. Returns `entity` unmodified, but interacts with the filesystem.
(read-dir entity key path)Reads a directory under path. Returns entity with file contents sequence stored under key.
Reads a directory under `path`. Returns `entity` with file contents sequence stored under `key`.
(update entity key & funs)Returns entity with value under key modified by succesively applying funs.
Returns `entity` with value under `key` modified by succesively applying `funs`.
(update-all entity key & funs)Returns entity with sequence under key modified by succesively applying funs to each of the elements.
Returns `entity` with sequence under `key` modified by succesively applying `funs` to each of the elements.
(whenever entity predicate? & funs)Returns entity modified by succesively applying funs if (predicate? entity) is true.
Returns `entity` modified by succesively applying `funs` if `(predicate? entity)` is true.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |