Liking cljdoc? Tell your friends :D

hydrox.doc.link.stencil


full-citation-patternclj

source

full-patternclj

source

(link-stencil folio name)

links extra information for using the stencil format (link-stencil {:articles {"example" {:meta {:name "world"} :elements [{:type :paragraph :text "{{PROJECT.version}} {{DOCUMENT.name}}"} {:type :paragraph :text "{{hello}} {{example.hello.label}}"}]}} :project {:version "0.1"} :anchors {"example" {"hello" {:number 2 :label "two"}}}} "example") => {:articles {"example" {:meta {:name "world"}, :elements [{:type :paragraph, :text "0.1 world"} {:type :paragraph, :text "2 two"}]}}, :project {:version "0.1"}, :anchors {"example" {"hello" {:number 2, :label "two"}}}}

links extra information for using the stencil format
(link-stencil
 {:articles {"example" {:meta {:name "world"}
                        :elements [{:type :paragraph
                                    :text "{{PROJECT.version}} {{DOCUMENT.name}}"}
                                   {:type :paragraph
                                    :text "{{hello}} {{example.hello.label}}"}]}}
  :project {:version "0.1"}
 :anchors {"example" {"hello" {:number 2
                                :label "two"}}}}
 "example")
=> {:articles {"example" {:meta {:name "world"},
                          :elements [{:type :paragraph, :text "0.1 world"}
                                     {:type :paragraph, :text "2 two"}]}},
    :project {:version "0.1"},
    :anchors {"example" {"hello" {:number 2, :label "two"}}}}
sourceraw docstring

short-citation-patternclj

source

short-patternclj

source

transform-stencilclj

(transform-stencil string name tags)

takes a short-form and expands using anchor information (transform-stencil "{{hello}}" "example" {"example" {"hello" {:number 1}}}) => "1"

(transform-stencil "{{stuff/create}}" "example" {"stuff" {"create" {:number 2}}}) => "2"

(transform-stencil "[[stuff/create]]" "example" {"stuff" {"create" {:number 2}}}) => "2"

(transform-stencil "[[create]]" "example" {"example" {"create" {:number 2}}}) => "2"

takes a short-form and expands using anchor information
(transform-stencil "{{hello}}" "example"
                   {"example" {"hello" {:number 1}}})
=> "1"

(transform-stencil "{{stuff/create}}" "example"
                   {"stuff" {"create" {:number 2}}})
=> "2"

(transform-stencil "[[stuff/create]]" "example"
                   {"stuff" {"create" {:number 2}}})
=> "[2](stuff.html#create)"

(transform-stencil "[[create]]" "example"
                   {"example" {"create" {:number 2}}})
=> "[2](#create)"
sourceraw docstring

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

× close