From 21c786cc23a956e8f0aff6f4c021221c05f96626 Mon Sep 17 00:00:00 2001
From: Simon Michael <simon@joyful.com>
Date: Thu, 30 Nov 2023 12:28:59 -1000
Subject: [PATCH] wikilinks: notes

---
 wikilinks.lua | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/wikilinks.lua b/wikilinks.lua
index b672477..8489ef3 100644
--- a/wikilinks.lua
+++ b/wikilinks.lua
@@ -2,8 +2,12 @@
 -- of [[bracketed wiki links]]. This lua filter does the rest, mimicking
 -- Obsidian's wiki linking where possible. It
 -- - replaces spaces with hyphens in the uri path and fragment
--- - adds ".html" to the path (preserving any fragment)
 -- - lower-cases the fragment
+-- - adds ".html" to the path (preserving any fragment).
+--   This is needed when the site is rendered locally, though not on hledger.org.
+-- Limitations: unlike Obsidian wikilinks,
+-- - these do not find files across folders - correct path is required
+-- - these are not aware of file existence - targets should exist
 
 function Link(elem)
    if elem.title == "wikilink" then