From 1cd093923066edaf4c02eaf3ffcf7ac465f3c1d1 Mon Sep 17 00:00:00 2001
From: Guy Godfroy <guy.godfroy@gugod.fr>
Date: Thu, 3 Dec 2020 09:01:30 +0100
Subject: [PATCH] Comment the ugly code

---
 geminer.py | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/geminer.py b/geminer.py
index a12df16..f5da22f 100755
--- a/geminer.py
+++ b/geminer.py
@@ -13,25 +13,41 @@ tpl_path = os.path.expanduser(config.tpl_dir)
 
 os.chdir(md_path)
 
+# Walk through markdown directories
 for dirname, subdirlist, mdlist in os.walk('.'):
+    
+    # Create same hierarchy in GMI directory
     gmi_subpath = os.path.abspath(gmi_path+"/"+dirname)
     os.makedirs(gmi_subpath, exist_ok=True)
+
     for mdfile in mdlist:
         basename, extension = os.path.splitext(mdfile)
         extension = extension[1:]
+        
+        # We want to ignore the file if this isn't a markdown file
         if extension not in config.md_extensions:
             print("Ignoring file {}: \"{}\" not in markdown extensions list".format(mdfile, extension))
             pass
+        
+        # Read the Markdown file
         with open(dirname+"/"+mdfile, 'r') as md:
             mdtext = md.read()
+        
+        # Parse the YAML header
         meta = frontmatter.parse(mdtext)[0]
+        
+        # Extract useful informations from the header
         template = meta.get("template", None)
         author = meta.get("author", None)
         date = meta.get("date", None)
         title = meta.get("title", None)
         tags = meta.get("tags", None)
+        # For now, tags list must be a comma-separated string
+        # TODO: make possible to list tags as a YAML list
         for item in config.replace:
             mdtext = mdtext.replace(item[0],item[1])
+
+        # Convert the post into GMI
         gmitext = md2gemini(mdtext,
                 code_tag=config.code_tag,
                 img_tag=config.img_tag,
@@ -45,13 +61,19 @@ for dirname, subdirlist, mdlist in os.walk('.'):
                 md_links=True,
                 table_tag=config.table_tag
                 )
+
+        # Read template file
         with open(tpl_path+"/"+template+".tpl", 'r') as tpl:
             template = Template(tpl.read())
+        
+        # We need the relative path without the "./"
         simpledirname = dirname[2:]
         if simpledirname == "":
             path = basename
         else:
             path = simpledirname + "/" + basename
+        
+        # Integrate the GMI content in the template
         gmitext = template.render(
                 content=gmitext,
                 tags=tags,
@@ -61,7 +83,11 @@ for dirname, subdirlist, mdlist in os.walk('.'):
                 title=title,
                 path=path
                 )
+        
+        # Dirty fix a weird bug where some lines are CRLF-terminated
         gmitext = gmitext.replace('\r\n','\n')
+        
+        # Time to write the GMI file
         gmifile = basename
         if config.gmi_extension:
             gmifile += ".gmi"