Feat: Enable excluding files from site-map.

teesloane · Jul 17, 2020 · bfaefc4 · bfaefc4
1 parent 8dced1d
commit bfaefc4
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/clojure/src/firn/build.clj b/clojure/src/firn/build.clj
@@ -139,12 +139,14 @@
                                   output
                                   (assoc output (processed-file :path-web) processed-file))
               new-site-map-item (merge
+                                 ;; remove metadata that would just pollute site-map links.
                                  (dissoc (processed-file :meta) :logbook :links :keywords :toc)
                                  {:path (str "/" (processed-file :path-web))})]
 
           ;; add to sitemap when file is not private.
           (when-not is-private
-            (swap! site-map conj new-site-map-item)
+            (when-not (= #p (-> processed-file :meta :keywords :firn-sitemap? ) false)
+              (swap! site-map conj new-site-map-item)) ;; add to site map unless user has specified not to.
             (swap! site-links concat (-> processed-file :meta :links))
             (swap! site-logs concat  (-> processed-file :meta :logbook))
             (swap! site-tags concat  (-> processed-file :meta :tags)))

diff --git a/clojure/src/firn/file.clj b/clojure/src/firn/file.clj
@@ -10,7 +10,7 @@
             [sci.core :as sci]))
 
 ;; #+ORG_KEYWORDS that we want to evaluate into real clojure values.
-(def keywords-to-eval [:firn-toc :firn-properties? :firn-order :firn-fold])
+(def keywords-to-eval [:firn-toc :firn-properties? :firn-order :firn-fold :firn-sitemap?])
 
 ;; -- Getters
 

diff --git a/docs/configuration.org b/docs/configuration.org
@@ -78,4 +78,5 @@ The following in-buffer settings are processed by Firn and/or made available to
 | ~#+FIRN_TOC~         | map           | Settings for any rendered table of contents     |
 | ~#+FIRN_ORDER~       | integer       | Enables sorting files in the site-map           |
 | ~#+FIRN_PRIVATE~     | boolean       | Whether or not to read the file in question     |
+| #+FIRN_SITEMAP?    | boolean       | Whether to include the file in the site-map.    |
 | ~#+FIRN_UNDER~       | string        | Category for which the documents falls under    |