parent 4b959df

author Andrea Amantini <[email protected]> 1680188333 +0200
committer Andrea Amantini <[email protected]> 1693237293 +0200

Add internal-link tokenizer

Make basic example functional

Allow internal links to namespaces

Make internal link scroll to var

Put the notebook title as link content

Make linter happy

Refactor

Fix hash fragment in links to var

Omit reader quote-var dispatch in link text

Kondo

Include notebook presentation in doc-url rebinding scope

Simplify

Explain

Coherent keys

Handle fragments from vars

Naming

Reduce noise

Author: zampino

src/nextjournal/clerk/parser.cljc

@@ -287,15 +287,17 @@
 
 (defn markdown-context []
   (update markdown.parser/empty-doc
-          :text-tokenizers (partial map markdown.parser/normalize-tokenizer)))
-
-#_(markdown-context)
+          :text-tokenizers
+          (comp (partial mapv markdown.parser/normalize-tokenizer)
+                (partial cons markdown.parser/internal-link-tokenizer))))
 
 (defn parse-markdown
   "Like `n.markdown.parser/parse` but allows to reuse the same context in successive calls"
   [ctx md]
   (markdown.parser/apply-tokens ctx (markdown/tokenize md)))
 
+#_(parse-markdown-string {:doc? true} "# Title\nSome [[internal-link]] to be followed.")
+
 (defn update-markdown-blocks [{:as state :keys [md-context]} md]
   (let [{::markdown.parser/keys [path]} md-context
         doc (parse-markdown md-context md)
@@ -348,9 +350,7 @@
        state))))
 
 #_(parse-clojure-string {:doc? true} "'code ;; foo\n;; bar")
-#_(parse-clojure-string "'code , ;; foo\n;; bar")
 #_(parse-clojure-string "'code\n;; foo\n;; bar")
-#_(keys (parse-clojure-string {:doc? true} (slurp "notebooks/viewer_api.clj")))
 #_(parse-clojure-string {:doc? true} ";; # Hello\n;; ## 👋 Section\n(do 123)\n;; ## 🤚🏽 Section")
 
 (defn parse-markdown-cell [{:as state :keys [nodes]} opts]

src/nextjournal/clerk/render.cljs

@@ -865,7 +865,7 @@
    [:path {:fill-rule "evenodd" :d "M5.293 7.293a1 1 0 011.414 0L10 10.586l3.293-3.293a1 1 0 111.414 1.414l-4 4a1 1 0 01-1.414 0l-4-4a1 1 0 010-1.414z" :clip-rule "evenodd"}]])
 
 (defn render-code-block [code-string {:as opts :keys [id]}]
-  [:div.viewer.code-viewer.w-full.max-w-wide {:data-block-id id}
+  [:div.viewer.code-viewer.w-full.max-w-wide {:id id}
    [code/render-code code-string (assoc opts :language "clojure")]])
 
 (defn render-folded-code-block [code-string {:as opts :keys [id]}]

src/nextjournal/clerk/viewer.cljc

@@ -31,6 +31,8 @@
                    (java.nio.file Files StandardOpenOption)
                    (javax.imageio ImageIO))))
 
+(declare doc-url)
+
 (defrecord ViewerEval [form])
 
 (defrecord ViewerFn [form #?(:cljs f)]
@@ -714,6 +716,43 @@
           (doto (java.text.SimpleDateFormat. "yyyy-MM-dd'T'HH:mm:ss.SSS-00:00")
             (.setTimeZone (java.util.TimeZone/getTimeZone "GMT")))))
 
+#?(:clj (defn resolve-internal-link [link]
+          (if (fs/exists? link)
+            {:path link}
+            (let [sym (symbol link)]
+              (if (qualified-symbol? sym)
+                (when-some [var (try (requiring-resolve sym)
+                                     (catch Exception _ nil))]
+                  (merge {:var var} (resolve-internal-link (-> var symbol namespace))))
+                (when-some [ns (try (require sym)
+                                    (find-ns sym)
+                                    (catch Exception _ nil))]
+                  (cond-> {:ns ns}
+                    (fs/exists? (analyzer/ns->file sym))
+                    (assoc :path (analyzer/ns->file sym)))))))))
+
+#_(resolve-internal-link "notebooks/hello.clj")
+#_(resolve-internal-link "nextjournal.clerk.tap")
+#_(resolve-internal-link "rule-30/board")
+
+(defn process-internal-link [link]
+  #?(:clj
+     (let [{:keys [path var]} (resolve-internal-link link)]
+       {:path path
+        :fragment (when var (str (-> var symbol str) "-code"))
+        :title (or (when var (-> var symbol str))
+                   (when path (:title (parser/parse-file {:doc? true} path)))
+                   link)})
+     :cljs
+     {:path link :title link}))
+
+#_(process-internal-link "notebooks/rule_30.clj")
+#_(process-internal-link "viewers.html")
+#_(process-internal-link "how-clerk-works/hashes")
+#_(process-internal-link "rule-30/first-generation")
+
+(declare html)
+
 (def markdown-viewers
   [{:name :nextjournal.markdown/doc
     :transform-fn (into-markup (fn [{:keys [id]}] [:div.viewer.markdown-viewer.w-full.max-w-prose.px-8 {:data-block-id id}]))}
@@ -742,6 +781,11 @@
    {:name :nextjournal.markdown/monospace :transform-fn (into-markup [:code])}
    {:name :nextjournal.markdown/strikethrough :transform-fn (into-markup [:s])}
    {:name :nextjournal.markdown/link :transform-fn (into-markup #(vector :a (:attrs %)))}
+   {:name :nextjournal.markdown/internal-link
+    :transform-fn (update-val
+                   (fn [{:keys [text]}]
+                     (let [{:keys [path fragment title]} (process-internal-link text)]
+                       (html [:a.internal-link {:href (doc-url path fragment)} title]))))}
 
    ;; inlines
    {:name :nextjournal.markdown/text :transform-fn (into-markup [:<>])}
@@ -1129,7 +1173,7 @@
 
 #_(update-if {:n "42"} :n #(Integer/parseInt %))
 
-(declare html doc-url)
+(declare html)
 
 (defn home? [{:keys [nav-path]}]
   (contains? #{"src/nextjournal/home.clj" "'nextjournal.clerk.home"} nav-path))