Liking cljdoc? Tell your friends :D
Mostly clj/s.
Exceptions indicated.

markdown-to-hiccup.core


componentclj/s

(component hiccup)

Accepts hiccup and returns the same hiccup only without the :html, :head, and :body elements. Useful if you want to nest your markdown hiccup in existing hiccup data structures.

Accepts hiccup and returns the same hiccup only
without the :html, :head, and :body elements. Useful
if you want to nest your markdown hiccup in existing
hiccup data structures.
raw docstring

file->hiccupclj

(file->hiccup file-path)

Generates a valid hiccup data structure from markdown contained in the .md file located at file-path

Generates a valid hiccup data structure from markdown
contained in the .md file located at file-path
raw docstring

hicc-inclj/s

(hicc-in hiccup & kws)

Deprecated. Please use hiccup-in for better access to nested hiccup. Accepts a hiccup data structure and a keyword representing an html element tag (e.g. :body) and returns the first nested hiccup vector identified by the keyword.

Deprecated. Please use hiccup-in for better access to nested hiccup.
Accepts a hiccup data structure and a keyword representing
an html element tag (e.g. :body) and returns the first nested
hiccup vector identified by the keyword.
raw docstring

hiccup-inclj/s

(hiccup-in hiccup & kw-pairs)

Accepts a hiccup data structure and any series of args in keyword, index order. Each keyword represents a hiccup element, and the paired index is which element at that level hiccup-in will look in. If no number proceeds a keyword, hiccup-in will find the first element with that keyword. Returns the nested hiccup vector identified by the keywords. Example: (hiccup-in hiccup :html :body :div 0 :h1 2 :p)

Accepts a hiccup data structure and any series of args in keyword, index order.
Each keyword represents a hiccup element, and the paired index is which element at that level hiccup-in will look in.
If no number proceeds a keyword, hiccup-in will find the first element with that keyword.
Returns the nested hiccup vector identified by the keywords.
Example: (hiccup-in hiccup :html :body :div 0 :h1 2 :p)
raw docstring

md->hiccupclj/s

(md->hiccup md-str)
(md->hiccup md-str params)

Accepts a markdown string and returns a hiccup data structure converted from that markdown. Also accepts an optional params map. Use the :encode? boolean key to specify whether or not you want html escape characters to be encoded. Example: (md->hiccup "#Title" {:encode? true})

Accepts a markdown string and returns a hiccup data structure converted from that markdown.
Also accepts an optional params map. Use the :encode? boolean key to specify whether
or not you want html escape characters to be encoded. Example:
  (md->hiccup "#Title" {:encode? true})
raw docstring

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

× close