diction.documentation

Liking cljdoc? Tell your friends :D

Clojure only.

->anchor^clj

(->anchor x)

Converts x to anchor name.

Converts `x` to anchor name.

source raw docstring

->hiccup^clj

(->hiccup)

(->hiccup ctx)

(->hiccup filter-f ctx)

Generate existing data dictionary into hiccup vectors with optional context ctx. Context ctx keys:

header : HTML string with header tags; freeform HTML
title : Title string of the generated HTML page HEAD and top header of HTML
stylesheet : CSS link
style : raw CSS text
suppress-style : if true, will suppress default CSS
start-body : HTML string with tags at the top of the BODY tag; freeform HTML
end-body : HTML string with tags at the bottom of the BODY tag; freeform HTML

Generate existing data dictionary into hiccup vectors with optional context `ctx`.
Context `ctx` keys:
- `header` : HTML string with header tags; freeform HTML
- `title` : Title string of the generated HTML page HEAD and top header of HTML
- `stylesheet` : CSS link
- `style` : raw CSS text
- `suppress-style` : if `true`, will suppress default CSS
- `start-body` : HTML string with tags at the top of the BODY tag; freeform HTML
- `end-body` : HTML string with tags at the bottom of the BODY tag; freeform HTML

source raw docstring

->html^clj

(->html)

(->html ctx)

(->html filter-f ctx)

Generate existing data dictionary into HTML string with optional context ctx. Context ctx keys:

header : HTML string with header tags; freeform HTML
title : Title string of the generated HTML page HEAD and top header of HTML
stylesheet : CSS link
style : raw CSS text
suppress-style : if true, will suppress default CSS
start-body : HTML string with tags at the top of the BODY tag; freeform HTML
end-body : HTML string with tags at the bottom of the BODY tag; freeform HTML

Generate existing data dictionary into HTML string with optional context `ctx`.
Context `ctx` keys:
- `header` : HTML string with header tags; freeform HTML
- `title` : Title string of the generated HTML page HEAD and top header of HTML
- `stylesheet` : CSS link
- `style` : raw CSS text
- `suppress-style` : if `true`, will suppress default CSS
- `start-body` : HTML string with tags at the top of the BODY tag; freeform HTML
- `end-body` : HTML string with tags at the bottom of the BODY tag; freeform HTML

source raw docstring

->markdown^clj

(->markdown)

(->markdown title)

(->markdown filter-f title)

Convert existing data dictionary into markdown with optional title.

Convert existing data dictionary into markdown with optional `title`.

source raw docstring

->markdown-elements^clj

(->markdown-elements elems body title)

Generate markdown elements elems given existing string body and title of the section.

Generate markdown elements `elems` given existing string `body` and
`title` of the section.

source raw docstring

->str^clj

(->str x)

Converts x to string.

Converts `x` to string.

source raw docstring

bullet^clj

source

bullet-line^clj

(bullet-line acc level s)

Generates a bullet line by concatenating a line to the acc accumulator string with indentions to the appropriate level and the line string s.

Generates a bullet line by concatenating a line to the `acc` accumulator
string with indentions to the appropriate `level` and the line string `s`.

source raw docstring

decorate-local-link-value^clj

source

decorate-value^clj

(decorate-value v)

(decorate-value vf v)

Decorate value v. Currently passes through maps, but comma-delimits collections.

Decorate value `v`.  Currently passes through maps, but comma-delimits collections.

source raw docstring

default-css^clj

source

doc-value^clj

(doc-value x)

Wrap value x with double-quotes if x is string.

Wrap value `x` with double-quotes if `x` is string.

source raw docstring

document-children-element-ids^clj

(document-children-element-ids element-info)

Retrieves children element ids from element-info.

Retrieves children element ids from `element-info`.

source raw docstring

document-element-keys^clj

source

element-bullet^clj

(element-bullet k v)

(element-bullet ref-ks k v)

Generate element bullet for key k and value v and optional set ref-ks that add local link refs if key k in ref-ks.

Generate element bullet for key `k` and value `v` and optional set `ref-ks`
that add local link refs if key `k` in `ref-ks`.

source raw docstring

element-bullet-legacy^clj

(element-bullet-legacy k v)

(element-bullet-legacy ref-ks k v)

Generate element bullet for key k and value v and optional set ref-ks that add local link refs if key k in ref-ks.

Generate element bullet for key `k` and value `v` and optional set `ref-ks`
that add local link refs if key `k` in `ref-ks`.

source raw docstring

exclude-element-fields^clj

source

generate-all^clj

(generate-all element-id)

Generates an element element-id with forced sensible-values to true and generate-all-fields to true.

Generates an element `element-id` with forced `sensible-values` to `true`
and `generate-all-fields` to `true`.

source raw docstring

indent^clj

(indent n)

Generates spaces for indenting line to level n.

Generates spaces for indenting line to level `n`.

source raw docstring

index->markdown^clj

(index->markdown fields)

Generate index markdown using data dictionary fields.

Generate index markdown using data dictionary `fields`.

source raw docstring

index-bullet^clj

(index-bullet id)

(index-bullet id lbl)

Generate index bullet for key id and optional label lbl.

Generate index bullet for key `id` and optional label `lbl`.

source raw docstring

kv-sep^clj

source

local-link^clj

(local-link x)

source

map->markdown^clj

(map->markdown m)

(map->markdown level m)

Convert meta meta for element id with optional level.

Convert meta `meta` for element `id` with optional `level`.

source raw docstring

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

Keyboard shortcuts Report a problem cljdoc on GitHub

× close