chore: add comments on how footnotes work

ashishb · Jul 6, 2024 · e7b986a · e7b986a
1 parent 5a302e3
commit e7b986a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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.