Chunk Types
:html
A raw html section. The gold standard for displaying content in a browser.
:html "<b>cat</b>":html-hiccup
Hiccup is a representation of html in clojure's edn format
:html-hiccup [:h1 "cat" ]:html-file
Display separate html file, and use the
Selmer project templates. (ie html file contains; Hello {{name}})
:html-file { :filename "test.html" :name "John" }:js-file
Inserts a js file at the current location in the document
:js-file "myjs.fo":plantuml-file
Describes the chunk as a plantuml diagram. The argument of the chunk type is the file. The file contains a plantuml text input for a diagram. explainer uses the plantuml library to generate the image and inserts the html to render the image on the page
:plantuml-file "alice-bob.pu":dot-file
A dot file is a variation on the plantuml-file. The input is a graphvis file. See
Graphvis (dot) examples and
https://graphviz.org/:dot-file "figure.dot":resource
Resource file needed for a page. Typically a png or
jpg file which is referenced in the :html or :html-provider. This is
needed to tell explainer to copy the resource from the input directory
to the output directory
:resource "cat.jgp":swagger-file
Provide a swagger yaml-file and it inserts the API
:swagger-file "my-swagger-file.yml":markdown
Provide markdown in the document. You can experiment with markdown at
Yogthos markdown site:markdown "# Boo
Halloween involves candy.":markdown-file
Provide a markdown file and insert it's contents as html
:markdown-file "my-markdown-file.md"