Liking cljdoc? Tell your friends :D

cljdoc.render.api

Functions related to rendering API documenation

Functions related to rendering API documenation
raw docstring

add-src-uriclj

(add-src-uri {:keys [platforms] :as mp-var} scm-base file-mapping)

def-blockclj

(def-block def render-wiki-link)

def-code-blockclj

(def-code-block args-str)

definitions-listclj

(definitions-list ns-entity defs {:keys [indicate-platforms-other-than]})

docstring->htmlclj

(docstring->html doc-str render-wiki-link)

humanize-supported-platformsclj

(humanize-supported-platforms supported-platforms)
(humanize-supported-platforms supported-platforms style)

namespace-listclj

(namespace-list {:keys [current]} namespaces)

namespace-overviewclj

(namespace-overview ns-url-fn mp-ns defs)

namespace-pageclj

(namespace-page {:keys [ns-entity ns-data defs scm-info]})

(parse-wiki-link m)

platform-statsclj

(platform-stats defs)

platform-support-noteclj

(platform-support-note [[dominant-platf] :as platf-stats])

render-arglistsclj

(render-arglists def-name arglists)

render-docclj

(render-doc mp render-wiki-link)

(render-wiki-link-fn current-ns ns-link-fn)

Given the current-ns and a function ns-link-fn that is assumed to return a link to a passed namespace, return a function that receives a [ns var] tuple and will return a Markdown link to the specified ns/var.

Given the `current-ns` and a function `ns-link-fn` that is assumed
to return a link to a passed namespace, return a function that receives
a `[ns var]` tuple and will return a Markdown link to the specified ns/var.
raw docstring

sub-namespace-overview-pageclj

(sub-namespace-overview-page {:keys [ns-entity namespaces defs]})

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

× close