nextjournal.markdown.parser — io.github.nextjournal/markdown 0.3.69

Deals with transforming a collection of markdown-it tokens obtained from parsing markdown text into an AST composed of nested clojure structures.

See parse function.

A "Node" has the following keys:

• type: a Node's type as keyword (:heading, :paragraph, :text, :code etc.)
• info: (optional) fenced code info
• content: (optional) a collection of Nodes representing nested content
• text: (optional) content of text nodes, a collection of Nodes
• heading-level: (on :heading nodes)
• attrs: attributes as passed by markdownit tokens (e.g {:attrs {:style "some style info"}})

add-title+toc clj/s

(add-title+toc {:as doc :keys [content]})

Computes and adds a :title and a :toc to the document-like structure doc which might have not been constructed by means of parse.

add-to-toc clj/s

(add-to-toc doc {:as h :keys [heading-level]})

apply-token clj/s multimethod

apply-tokens clj/s

(apply-tokens doc tokens)

block-formula clj/s

(block-formula text)

close-node clj/s

(close-node doc)

empty-doc clj/s

empty-text-node? clj/s

(empty-text-node? {text :text t :type})

formula clj/s

(formula text)

get-in* clj/s

hlevel clj/s

(hlevel {:as _token hn :tag})

inc-last clj/s

(inc-last path)

into-toc clj/s

(into-toc toc {:as toc-item :keys [heading-level]})

node clj/s

(node type content attrs top-level)

open-node clj/s

(open-node doc type)

(open-node doc type attrs)

(open-node doc type attrs top-level)

pairs->kmap clj/s

(pairs->kmap pairs)

parse clj/s

(parse tokens)

(parse doc tokens)

Takes a doc and a collection of markdown-it tokens, applies tokens to doc. Uses an emtpy doc in arity 1.

parse-fence-info clj/s

(parse-fence-info info-str)

Ingests nextjournal, GFM, Pandoc and RMarkdown fenced code block info, returns a map

Nextjournal

  ...

Pandoc

  ...

Rmd

  ...

See also:

• https://github.github.com/gfm/#info-string
• https://pandoc.org/MANUAL.html#fenced-code-blocks
• https://rstudio.com/wp-content/uploads/2016/03/rmarkdown-cheatsheet-2.0.pdf

push-node clj/s

(push-node {:as doc :nextjournal.markdown.parser/keys [path]} node)

push-nodes clj/s

re-groups* clj

(re-groups* m)

re-idx-seq clj/s

(re-idx-seq re text)

Takes a regex and a string, returns a seq of triplets comprised of match groups followed by indices delimiting each match.

section-at clj/s

(section-at {:as doc :keys [content]} [_ pos :as path])

set-title-when-missing clj/s

(set-title-when-missing {:as doc :keys [title]} heading)

sidenote-ref clj/s

(sidenote-ref ref)

tag-node clj/s

(tag-node text)

text-node clj/s

(text-node text)

text-tokenizers clj/s

handler :: Match -> Node

tokenize-text clj/s

(tokenize-text {:keys [regex handler]} text)

update* clj/s

update-current clj/s

(update-current {:as doc path :nextjournal.markdown.parser/path} fn & args)