Liking cljdoc? Tell your friends :D

glossa.weave


default-display-widthclj

source

default-envclj

source

default-line-commentclj

source

emitclj

(emit env parsed-doc)
source

envclj

(env)
(env env-map)

Return a Weave env. Optional env-map is simply merged with defaults if provided.

Return a Weave env. Optional `env-map` is simply merged with defaults if provided.
sourceraw docstring

format-for-replclj

(format-for-repl string)
(format-for-repl string opts)
source

parseclj

(parse weave-doc)
source

readmeclj

(readme)
(readme {:keys [version sha tag]})
source

renderclj

(render env ir-instructions)
source

stitchclj

(stitch {:keys [stitch-fn] :as _env} stack)
source

weaveclj

(weave weave-doc)
(weave env weave-doc)

Produce a string of your rendered document given a weave-doc tree.

Produce a string of your rendered document given a `weave-doc` tree.
sourceraw docstring

weave+clj

(weave+ weave-doc)
(weave+ env weave-doc)

Return a map of:

  • :doc The final document, as a string
  • :env The final environment used during document processing

Custom implementations of api/emit or api/render can tuck values into the env argument they receive. This function exposes those values for use after document processing.

Return a map of:

 - `:doc` The final document, as a string
 - `:env` The final environment used during document processing

Custom implementations of `api/emit` or `api/render` can tuck values
into the `env` argument they receive. This function exposes those values
for use after document processing.
sourceraw docstring

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

× close