Liking cljdoc? Tell your friends :D

hydrox.doc.link.references


(link-references {:keys [references] :as folio} name)

link code for elements to references

(link-references {:articles {"example" {:elements [{:type :reference :refer 'example.core/hello}]}} :references '{example.core {hello {:docs [] :source "(defn hello [] 1)"}}}} "example") => {:articles {"example" {:elements '[{:type :code, :refer example.core/hello, :origin :reference, :indentation 0, :code "(defn hello [] 1)", :mode :source, :title "source of <i>example.core/hello</i>"}]}}, :references '{example.core {hello {:docs [], :source "(defn hello [] 1)"}}}}

link code for elements to references

(link-references {:articles {"example" {:elements [{:type :reference :refer 'example.core/hello}]}}
                  :references '{example.core {hello {:docs []
                                                     :source "(defn hello [] 1)"}}}}
                 "example")
=> {:articles
    {"example"
    {:elements
      '[{:type :code,
         :refer example.core/hello,
         :origin :reference,
         :indentation 0,
         :code "(defn hello [] 1)",
         :mode :source,
         :title "source of <i>example.core/hello</i>"}]}},
    :references '{example.core {hello {:docs [], :source "(defn hello [] 1)"}}}}
sourceraw docstring

process-doc-nodesclj

(process-doc-nodes docs)

treat test nodes specially when rendering code

(->> (z/of-string "(+ 1 1) => (+ 2 2)") (iterate z/right*) (take-while identity) (map z/node) (process-doc-nodes)) => "(+ 1 1) => (+ 2 2)"

treat test nodes specially when rendering code

(->> (z/of-string "(+ 1 1) => (+ 2 2)")
     (iterate z/right*)
     (take-while identity)
     (map z/node)
     (process-doc-nodes))
=> "(+ 1 1) => (+ 2 2)"
sourceraw docstring

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

× close