From acfb27574b0f42a8e33ba9cb171e9e6400d0939b Mon Sep 17 00:00:00 2001 From: onionpancakes <639985+onionpancakes@users.noreply.github.com> Date: Tue, 20 Feb 2024 12:20:53 -0800 Subject: [PATCH] added compile example on top --- README.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6589bcd..ee6b61f 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ Currently for my personal use. Future breaking changes possible. # Example +### Runtime HTML Serialization + ```clojure (require '[dev.onionpancakes.chassis.core :as c]) @@ -52,6 +54,38 @@ Currently for my personal use. Future breaking changes possible. ;; "My Blog

My Blog

foo

bar

" ``` +### Compiled HTML Serialization + +```clojure +(require '[dev.onionpancakes.chassis.core :as c]) +(require '[dev.onionpancakes.chassis.compiler :as cc]) + +(defn compiled-my-post + [post] + (cc/compile + [:div {:id (:id post)} + [:h2.title (:title post)] + [:p.content (:content post)]])) + +(defn compiled-my-blog + [data] + (cc/compile + [c/doctype-html5 ; Raw string for + [:html + [:head + [:link {:href "/css/styles.css" :rel "stylesheet"}] + [:title "My Blog"]] + [:body + [:h1 "My Blog"] + (for [p (:posts data)] + (compiled-my-post p))]]])) + +(let [data {:posts [{:id "1" :title "foo" :content "bar"}]}] + (c/html (compiled-my-blog data))) + +;; "My Blog

My Blog

foo

bar

" +``` + # Usage Require the namespace. @@ -593,8 +627,6 @@ Use `cc/compile*` to ensure the return value is a vector. Otherwise, it is the s ;; [#object[dev.onionpancakes.chassis.core.RawString 0x24f1caeb "
"]] ``` - - ## Ambiguous Attributes Produce Speed Bumps Ambiguous objects in the second position forces the compiler to emit checks which examine the potential attributes map at runtime. @@ -602,6 +634,7 @@ Ambiguous objects in the second position forces the compiler to emit checks whic ```clojure (let [data {:body "foo"}] (pprint (macroexpand-1 + ;; Compiler can't see what (:body data) returns. '(cc/compile [:div (:body data)])))) ;; Results in: