Add front matter comments to documentation files and update index cre…

…ation logic
russhustle · Feb 24, 2025 · 08538d5 · 08538d5
1 parent 3e0cac7
commit 08538d5
Show file tree

Hide file tree

Showing 8 changed files with 34 additions and 6 deletions.
diff --git a/docs/blind75/index.md b/docs/blind75/index.md
@@ -1 +1,5 @@
+---
+comments: True
+---
+
 # Blind 75
diff --git a/docs/company/index.md b/docs/company/index.md
@@ -1,3 +1,7 @@
+---
+comment: True
+---
+
 # Company Wise
 
 -   [liquidslr/leetcode-company-wise-problems](https://github.com/liquidslr/leetcode-company-wise-problems)
diff --git a/docs/graph_theory/index.md b/docs/graph_theory/index.md
@@ -1,3 +1,7 @@
+---
+comment: True
+---
+
 # Graph Theory
 
 ## Resources

diff --git a/docs/grind75/index.md b/docs/grind75/index.md
@@ -1 +1,5 @@
+---
+comments: True
+---
+
 # Grind 75
diff --git a/docs/leetpattern/index.md b/docs/leetpattern/index.md
@@ -1 +1,5 @@
+---
+comments: True
+---
+
 # LeetPattern
diff --git a/docs/neetcode150/index.md b/docs/neetcode150/index.md
@@ -1 +1,5 @@
+---
+comments: True
+---
+
 # Neetcode 150
diff --git a/docs/sql50/index.md b/docs/sql50/index.md
@@ -1,12 +1,16 @@
+---
+comment: True
+---
+
 # SQL 50
 
+-   List: [LeetCode SQL 50](https://leetcode.com/studyplan/top-sql-50/) | [高频 SQL 50 题（基础版）](https://leetcode.cn/studyplan/sql-free-50/)
+-   YouTube Playlist: [SQL 50 Series by Everyday Data Science](https://youtube.com/playlist?list=PLtfxzVLWb-B-aQ1U1AaOA8LBrCoE-3TX2&si=w6jfUlHL1EZK2ajn)
+
 ![inner join](https://www.w3schools.com/sql/img_inner_join.png)
 
 ![left join](https://www.w3schools.com/sql/img_left_join.png)
 
 ![right join](https://www.w3schools.com/sql/img_right_join.png)
 
 ![full join](https://www.w3schools.com/sql/img_full_outer_join.png)
-
--   List: [LeetCode SQL 50](https://leetcode.com/studyplan/top-sql-50/) | [高频 SQL 50 题（基础版）](https://leetcode.cn/studyplan/sql-free-50/)
--   YouTube Playlist: [SQL 50 Series by Everyday Data Science](https://youtube.com/playlist?list=PLtfxzVLWb-B-aQ1U1AaOA8LBrCoE-3TX2&si=w6jfUlHL1EZK2ajn)
diff --git a/main.py b/main.py
@@ -38,12 +38,13 @@ def create(config_path: str) -> str:
     src = os.path.join("src")
     docs = os.path.join("docs")
     folder = os.path.join(docs, cfg.dir)
+    comments = "---\ncomments: True\n---\n\n"
     if not os.path.exists(folder):
         os.makedirs(folder)
     index_md_path = os.path.join(folder, "index.md")
     if not os.path.exists(index_md_path):
         with open(index_md_path, "w") as f:
-            f.write(f"# {cfg.name}\n\n")
+            f.write(comments + f"# {cfg.name}\n\n")
 
     df = pd.read_parquet(os.path.join("utils", "questions.parquet"))
 
@@ -56,8 +57,7 @@ def create(config_path: str) -> str:
 
         mkdocs += f"    - {topic}: {cfg.dir}/{md_path_name}\n"
 
-        content = "---\ncomments: True\n---\n\n"
-        content += f"# {topic}\n\n"
+        content = comments + f"# {topic}\n\n"
         problems = cfg.topics[topic]
 
         for idx in problems: