Liking cljdoc? Tell your friends :D

fr.jeremyschoffen.prose.alpha.document.lib

Api providing several tools to use inside or outside of prose document.

Api providing several tools to use inside or outside of prose document.
raw docstring

<>clj/s

(<> & content)

Fragment tag whose content is meant to be spliced into its parent's content.

Fragment tag whose content is meant to be spliced into its parent's content.
sourceraw docstring

conform-or-throwclj/s

(conform-or-throw spec v)

Conforms the value v using the spec spec and throws an ex-info if v is invalid.

Conforms the value `v` using the spec `spec` and throws an `ex-info` if `v` is invalid.
sourceraw docstring

def-sclj/smacro

(def-s & args)

Same as def excpet that it returns and empty string.

Same as `def` excpet that it returns and empty string.
sourceraw docstring

def-xml-tagclj/s≠macro

clj
(def-xml-tag name docstring? keyword-name?)
cljs
(def-xml-tag & args)

Helper in making functions that construct tags.

Args:

  • name: name of the function
  • docstring?: a docstring for the function
  • keyword-name?: the actual name of the tag, defaults to the keyword version of name
Helper in making functions that construct tags.

Args:
- `name`: name of the function
- `docstring?`: a docstring for the function
- `keyword-name?`: the actual name of the tag, defaults to the keyword version of `name`
sourceraw docstring

def-xml-tagsclj/smacro

(def-xml-tags & tags)
source

defmacro-sclj/smacro

(defmacro-s & args)

Same as defmacro excpet that it returns and empty string.

Same as `defmacro` excpet that it returns and empty string.
sourceraw docstring

defn-sclj/smacro

(defn-s & args)
source

get-envclj/s

(get-env)
(get-env k)

Get the evaluation environment or the value for one of its keys.

Get the evaluation environment or the value for one of its keys.
sourceraw docstring

get-eval-docclj/s

(get-eval-doc)

Get the eval-forms function from the evaluation environment.

Get the eval-forms function from the evaluation environment.
sourceraw docstring

get-inputclj/s

(get-input)

Get the input value from the evaluation environment.

Get the input value from the evaluation environment.
sourceraw docstring

get-read-docclj/s

(get-read-doc)

Get the reading function from the evaluation environment.

Get the reading function from the evaluation environment.
sourceraw docstring

get-slurp-docclj/s

(get-slurp-doc)

Get the slurping function from the evaluation environment.

Get the slurping function from the evaluation environment.
sourceraw docstring

insert-docclj/smacro

(insert-doc path)

Insert the slurped and read content of another document.

Insert the slurped and read content of another document.
sourceraw docstring

require-docclj/s

(require-doc path)

Insert the slurped and read and evaluated content of another document.

Insert the slurped and read and evaluated content of another document.
sourceraw docstring

special?clj/s

(special? x)

Determine if x is a special tag.

Determine if `x` is a special tag.
sourceraw docstring

tag-typeclj/s

(tag-type x)

Returns the type of a tag x or nil isn't a map or doesn't have a type.

Returns the type of a tag `x` or nil isn't a map or doesn't have a type.
sourceraw docstring

tag?clj/s

(tag? x)

Determine if x is a normal tag.

Determine if `x` is a normal tag.
sourceraw docstring

xml-tagclj/s≠

clj
(xml-tag name attrs? & content)
cljs
(xml-tag & args)

Constructor of normal tags.

args:

  • name: a keyword giving the tag his name (:div, :my-tag, etc...)
  • attrs: a map of attributes
  • content: the content of the tag, strings, other (special)tags or sequences of both.

Returns a map similar to:

{:type :tag
 :tag name
 :attrs attrs?
 :content content}
Constructor of normal tags.

args:
- `name`: a keyword giving the tag his name (:div, :my-tag, etc...)
- `attrs`: a map of attributes
- `content`: the content of the tag, strings, other (special)tags or sequences of both.

Returns a map similar to:
```clojure
{:type :tag
 :tag name
 :attrs attrs?
 :content content}
```
sourceraw docstring

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

× close