Tweak sample doc and add it to snapshot build

notebooks/viewers_meta.clj → notebooks/viewer_api_meta.clj

@@ -1,4 +1,4 @@
-;; # Viewers Meta
+;; # Metadata-Based Viewer API
 ^{:nextjournal.clerk/visibility :hide-ns}
 (ns ^:nextjournal.clerk/no-cache viewers-meta
   (:require [nextjournal.clerk :as clerk]))
@@ -8,15 +8,15 @@
 (def tabular-data
   (clerk/table {:col-1 ["a" "b" "c"] :col-2 ["a" "b" "c"]}))
 
-;; This isn't always what you want as it performs a tranformation of your data.
+;; This isn't always what you want as it performs a transformation of your data.
 (keys tabular-data)
 
-;; If this isn't what you want because you depend on it downstream, you can alternatively use metadata to convey the viewer.
-
+;; You can alternatively use metadata on the form to convey the viewer.
 ^{::clerk/viewer clerk/table}
 (def tabular-data-untouched
   {:col-1 ["a" "b" "c"] :col-2 ["a" "b" "c"]})
 
+;; And see that it remains untouched. This comes with the added benefit that changing a viewer does not require a recomputation.
 (keys tabular-data-untouched)
 
 ;; This also works on literals, not just on vars. Though you will less care about transformation in that case – as you'll not be holding a reference to it. As you see in the following example, you can also use keywords instead of functions. This is useful when you don't want to require Clerk.

src/nextjournal/clerk.clj

@@ -314,6 +314,7 @@
          "rule_30"
          "visibility"
          "viewer_api"
+         "viewer_api_meta"
          "viewers/html"
          "viewers/image"
          "viewers/markdown"

src/nextjournal/clerk/viewer.cljc

@@ -65,7 +65,6 @@
     (:nextjournal/value x)
     x))
 
-
 #_(value (with-viewer :code '(+ 1 2 3)))
 #_(value 123)
 
@@ -75,6 +74,7 @@
   (when (map? x)
     (:nextjournal/viewer x)))
 
+
 #_(viewer (with-viewer :code '(+ 1 2 3)))
 #_(viewer "123")