From e7b986a2f75fa1c9ba76e8d078d9f56aedd275d9 Mon Sep 17 00:00:00 2001
From: Ashish Bhatia <ashishb@ashishb.net>
Date: Sat, 6 Jul 2024 01:54:05 -0700
Subject: [PATCH] chore: add comments on how footnotes work

---
 src/wp2hugo/internal/hugogenerator/hugopage/hugo_page.go | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/wp2hugo/internal/hugogenerator/hugopage/hugo_page.go b/src/wp2hugo/internal/hugogenerator/hugopage/hugo_page.go
index bb25675..206696e 100644
--- a/src/wp2hugo/internal/hugogenerator/hugopage/hugo_page.go
+++ b/src/wp2hugo/internal/hugogenerator/hugopage/hugo_page.go
@@ -186,6 +186,8 @@ func (page *Page) getMarkdown(provider ImageURLProvider, htmlContent string, foo
 		log.Debug().Msg("Auto-detecting languages of code blocks is disabled for now")
 	}
 
+	// Replace footnote links with actual Hugo-style footnotes
+	// Ref: https://geekthis.net/post/hugo-footnotes-and-citations
 	footnoteStrs := make([]string, 0, len(footnotes))
 	if len(footnotes) > 0 {
 		// [^1]: And that's the footnote.