Keep option undocumented while experimental

nextjournal · Dec 13, 2023 · 5ff08c5 · 5ff08c5
1 parent 39822d6
commit 5ff08c5
Showing 1 changed file with 7 additions and 14 deletions.
diff --git a/src/nextjournal/clerk.clj b/src/nextjournal/clerk.clj
@@ -437,7 +437,7 @@
 
   When both `:paths` and `:paths-fn` are given, `:paths` takes precendence.
 
-  Can be called multiple times and Clerk will happily serve you according to the latest config."
+  Can be called multiple times and Clerk will happily serve you according to the latest config."  
   {:org.babashka/cli {:spec {:watch-paths {:desc "Paths on which to watch for changes and show a changed document."
                                            :coerce []}
                              :paths {:desc "Restricts serving to the given paths, supports glob patterns. Will disable Clerk's homepage when set."
@@ -498,16 +498,12 @@
 
   Passing at least one of the above is required. When both `:paths` and `:paths-fn` are given, `:paths` takes precendence.
 
-  - `:bundle`              - if true results in a single self-contained html file including inlined images
-  - `:render-router`       - a keyword which determines how navigation among built notebooks behaves, possible values are:
-                               `:fetch-edn` when clicking a link, target document data is fetched and swapped when request
-                               completes. This is the only allowed value at the moment. By default, this setting is not
-                               enabled (no client-side routing is taking place).
-  - `:compile-css`         - if true compiles css file containing only the used classes
-  - `:ssr`                 - if true runs react server-side-rendering and includes the generated markup in the html
-  - `:browse`              - if true will open browser with the built file on success
-  - `:dashboard`           - if true will start a server and show a rich build report in the browser (use with `:bundle` to open browser)
-  - `:out-path`            - a relative path to a folder to contain the static pages (defaults to `\"public/build\"`)
+  - `:bundle`      - if true results in a single self-contained html file including inlined images
+  - `:compile-css` - if true compiles css file containing only the used classes
+  - `:ssr`         - if true runs react server-side-rendering and includes the generated markup in the html
+  - `:browse`      - if true will open browser with the built file on success
+  - `:dashboard`   - if true will start a server and show a rich build report in the browser (use with `:bundle` to open browser)
+  - `:out-path`    - a relative path to a folder to contain the static pages (defaults to `\"public/build\"`)
   - `:git/sha`, `:git/url` - when both present, each page displays a link to `(str url \"blob\" sha path-to-notebook)`
   "
   {:org.babashka/cli {:spec {:paths {:desc "Paths to notebooks toc include in the build, supports glob patterns."
@@ -516,9 +512,6 @@
                                         :coerce :symbol}
                              :index {:desc "Override the name of the index file (default `index.clj|md`), will be added to paths."}
                              :bundle {:desc "Flag to build a self-contained html file inlcuding inlined images"}
-                             :render-router {:desc "A keyword to select the routing mode"
-                                             :coerce :keyword
-                                             :validate #{:serve :bundle :fetch-edn}}
                              :browse {:desc "Opens the browser on boot when set."}
                              :dashboard {:desc "Flag to serve a dashboard with the build progress."}
                              :out-path {:desc "Path to an build output folder, defaults to \"public/build\"."}