From c3e02a0d1aeec604533bd064d9528f338e3981b6 Mon Sep 17 00:00:00 2001
From: surdeus <surdeus@gmail.com>
Date: Wed, 25 Dec 2024 00:43:55 +0500
Subject: [PATCH] feat: moving from old name conventions.

---
 CONTRIBUTING.md => contributing.md | 0
 CONTRIBUTORS.md => contributors.md | 0
 DESIGN.md => design.md             | 0
 LICENSE.txt => license.txt         | 0
 README.md => readme.md             | 0
 src/rendering.rs                   | 4 ++++
 6 files changed, 4 insertions(+)
 rename CONTRIBUTING.md => contributing.md (100%)
 rename CONTRIBUTORS.md => contributors.md (100%)
 rename DESIGN.md => design.md (100%)
 rename LICENSE.txt => license.txt (100%)
 rename README.md => readme.md (100%)

diff --git a/CONTRIBUTING.md b/contributing.md
similarity index 100%
rename from CONTRIBUTING.md
rename to contributing.md
diff --git a/CONTRIBUTORS.md b/contributors.md
similarity index 100%
rename from CONTRIBUTORS.md
rename to contributors.md
diff --git a/DESIGN.md b/design.md
similarity index 100%
rename from DESIGN.md
rename to design.md
diff --git a/LICENSE.txt b/license.txt
similarity index 100%
rename from LICENSE.txt
rename to license.txt
diff --git a/README.md b/readme.md
similarity index 100%
rename from README.md
rename to readme.md
diff --git a/src/rendering.rs b/src/rendering.rs
index 1a78eec..4dcd166 100644
--- a/src/rendering.rs
+++ b/src/rendering.rs
@@ -28,7 +28,11 @@ pub fn render_markdown_for_fts(src: &str) -> String {
 
     for event in p {
         match event {
+            // As far as I understand this is a basic
+            // sanitizing to prevent HTML from
+            // appearing  in page.
             Text(text) => buf.push_str(&text.replace(is_html_special, " ")),
+            // Footnote links maybe?
             End(Tag::Link(uri, _title)) => {
                 buf.push_str(" (");
                 buf.push_str(&uri.replace(is_html_special, " "));