Add links to index on function definitions

Author: WardBrian

.gitignore

@@ -29,3 +29,5 @@ src/**/*.tex
 
 # For the Mac (Finder metatdata files)
 *.DS_Store
+
+.luarc.json

src/html-index.lua

@@ -4,16 +4,22 @@
 -- This is combined with the output of the gen_index.py script
 -- to create a clickable index of all the functions in the documentation
 
+
+index = quarto.utils.resolve_path("./functions-reference/functions_index.qmd")
+indexText = io.open(index):read("*a")
+
 function extractIndexEntry(elementText)
   if elementText:find("%; %-%-%>$") ~= nil then
     return "index-entry-" .. tostring(pandoc.sha1(elementText))
   end
   return nil
 end
 
-if FORMAT == "latex" then
-  return {} -- latex uses mkindex, not this
-else
+function escape(text)
+  return text:gsub("\\", "\\\\"):gsub("*", "\\*")
+end
+
+if quarto.doc.is_format("html") then -- latex uses mkindex, not this
   return {
     RawBlock = function(el)
       if el.format == "html" then
@@ -23,6 +29,22 @@ else
         end
       end
       return nil -- no change
+    end,
+    Strong = function(el2)
+      return pandoc.walk_inline(el2, {
+        Code = function(el3)
+          if el3.text ~= nil then
+            -- only create a link if this appears in the index
+            local escaped = escape(el3.text)
+            if indexText:find(escaped, 1, true) ~= nil then
+              return pandoc.Link(el3, "./functions_index.qmd#" .. escaped,
+                "Jump to index entry", {class="unlink"})
+            end
+          end
+          return nil
+        end
+      })
     end
   }
+
 end

src/theming/quarto_styles.css

@@ -18,6 +18,9 @@
 }
 }
 
+html {
+  scroll-padding-top: 70px; /* height of header */
+}
 
 @media (min-width: 991.98px) {
 #quarto-header {
@@ -308,6 +311,11 @@ a.nav-link.active { color: var(--stan-secondary);}
 a.sidebar-item-text.sidebar-link.active { color: var(--stan-secondary); }
 .sidebar.a.active { color: var(--stan-secondary); }
 
+a.unlink {
+  color: inherit;
+  text-decoration: none;
+}
+
 
 div [data-bs-target^="#quarto-sidebar-section"] {
     font-weight: bold;