Merge pull request #533 from hugo-fixit/feat/task-lists

🎉 Feat: support Obsidian style task lists Closes #532
hugo-fixit · Nov 2, 2024 · 85d91b8 · 85d91b8
2 parents 8d10880 + 3a5d0de
commit 85d91b8
Show file tree

Hide file tree

Showing 20 changed files with 265 additions and 11 deletions.
diff --git a/assets/css/_core/_root.scss b/assets/css/_core/_root.scss
@@ -1,7 +1,7 @@
 :root {
   // Note: Custom variable values only support SassScript inside `#{}`.
 
-  // Theme colors varibles
+  // Theme colors variables
   @each $color, $value in $theme-colors {
     --#{$prefix}#{$color}: #{$value};
   }
@@ -22,6 +22,8 @@
   --#{$prefix}scrollbar-track-color: transparent;
   --#{$prefix}scrollbar-width: thin;
   --#{$prefix}scrollbar-width-legacy: 12px;
+
+  // TODO  migrate SCSS variables to CSS variables
 }
 
 // Dark theme

diff --git a/assets/css/_page/_single.scss b/assets/css/_page/_single.scss
@@ -230,6 +230,38 @@
 
     ul {
       list-style-type: disc;
+
+      // Task lists
+      li[data-task] {
+        list-style: none;
+        margin-left: -1.5rem;
+      }
+    }
+
+    // Task lists
+    li[data-task] {
+      color: var(--#{$prefix}task-color);
+      .checkbox-icon {
+        margin-right: 0.25em;
+        color: var(--#{$prefix}checkbox-color);
+      }
+    }
+    li[data-task='x'],
+    li[data-task='-'] {
+      --#{$prefix}task-color: var(--#{$prefix}secondary);
+      text-decoration: line-through;
+    }
+    li[data-task='x'] {
+      --#{$prefix}checkbox-color: var(--#{$prefix}primary);
+    }
+    li[data-task='/'] {
+      --#{$prefix}task-color: var(--#{$prefix}success);
+    }
+    li[data-task='!'] {
+      --#{$prefix}checkbox-color: var(--#{$prefix}danger);
+    }
+    li[data-task='?'] {
+      --#{$prefix}checkbox-color: var(--#{$prefix}warning);
     }
 
     dl {

diff --git a/hugo.toml b/hugo.toml
@@ -688,6 +688,12 @@ enableEmoji = true
   # syntax: <type> = <icon>
   [params.admonition]
     # ban = "fa-solid fa-ban"
+
+  # FixIt 0.3.14 | NEW Task lists custom config
+  # See https://fixit.lruihao.cn/documentation/content-management/advanced/#custom-task-lists
+  # syntax: <sign> = <icon>
+  [params.taskList]
+    # tip = "fa-regular fa-lightbulb"
 
   # FixIt 0.2.12 | NEW PanguJS config
   [params.pangu]

diff --git a/i18n/de.toml b/i18n/de.toml
@@ -182,6 +182,18 @@ warning = ""
 caution = ""
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = ""
+"x" = ""
+"/" = ""
+"-" = ""
+"<" = ""
+">" = ""
+"!" = ""
+"?" = ""
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "Notiz"

diff --git a/i18n/en.toml b/i18n/en.toml
@@ -181,6 +181,18 @@ warning = "Warning"
 caution = "Caution"
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = "Unchecked"
+"x" = "Checked"
+"/" = "In Progress"
+"-" = "Cancelled"
+"<" = "Scheduled"
+">" = "Rescheduled"
+"!" = "Important"
+"?" = "Question"
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "Note"

diff --git a/i18n/es.toml b/i18n/es.toml
@@ -182,6 +182,18 @@ warning = ""
 caution = ""
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = ""
+"x" = ""
+"/" = ""
+"-" = ""
+"<" = ""
+">" = ""
+"!" = ""
+"?" = ""
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "Nota"

diff --git a/i18n/fr.toml b/i18n/fr.toml
@@ -181,6 +181,18 @@ warning = ""
 caution = ""
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = ""
+"x" = ""
+"/" = ""
+"-" = ""
+"<" = ""
+">" = ""
+"!" = ""
+"?" = ""
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "Remarque"

diff --git a/i18n/hi.toml b/i18n/hi.toml
@@ -182,6 +182,18 @@ warning = ""
 caution = ""
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = ""
+"x" = ""
+"/" = ""
+"-" = ""
+"<" = ""
+">" = ""
+"!" = ""
+"?" = ""
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "ध्यान दें"

diff --git a/i18n/it.toml b/i18n/it.toml
@@ -182,6 +182,18 @@ warning = ""
 caution = ""
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = ""
+"x" = ""
+"/" = ""
+"-" = ""
+"<" = ""
+">" = ""
+"!" = ""
+"?" = ""
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "Note"

diff --git a/i18n/pl.toml b/i18n/pl.toml
@@ -182,6 +182,18 @@ warning = ""
 caution = ""
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = ""
+"x" = ""
+"/" = ""
+"-" = ""
+"<" = ""
+">" = ""
+"!" = ""
+"?" = ""
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "Notka"

diff --git a/i18n/pt-BR.toml b/i18n/pt-BR.toml
@@ -182,6 +182,18 @@ warning = ""
 caution = ""
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = ""
+"x" = ""
+"/" = ""
+"-" = ""
+"<" = ""
+">" = ""
+"!" = ""
+"?" = ""
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "Nota"

diff --git a/i18n/ro.toml b/i18n/ro.toml
@@ -182,6 +182,18 @@ warning = ""
 caution = ""
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = ""
+"x" = ""
+"/" = ""
+"-" = ""
+"<" = ""
+">" = ""
+"!" = ""
+"?" = ""
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "Notă"

diff --git a/i18n/ru.toml b/i18n/ru.toml
@@ -182,6 +182,18 @@ warning = ""
 caution = ""
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = ""
+"x" = ""
+"/" = ""
+"-" = ""
+"<" = ""
+">" = ""
+"!" = ""
+"?" = ""
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "Замечание"

diff --git a/i18n/sr.toml b/i18n/sr.toml
@@ -182,6 +182,18 @@ warning = ""
 caution = ""
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = ""
+"x" = ""
+"/" = ""
+"-" = ""
+"<" = ""
+">" = ""
+"!" = ""
+"?" = ""
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "Напомена"

diff --git a/i18n/vi.toml b/i18n/vi.toml
@@ -181,6 +181,18 @@ warning = ""
 caution = ""
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = ""
+"x" = ""
+"/" = ""
+"-" = ""
+"<" = ""
+">" = ""
+"!" = ""
+"?" = ""
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "Ghi chú"

diff --git a/i18n/zh-CN.toml b/i18n/zh-CN.toml
@@ -177,6 +177,18 @@ warning = "警告"
 caution = "小心"
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = "未完成"
+"x" = "已完成"
+"/" = "进行中"
+"-" = "已取消"
+"<" = "已计划"
+">" = "已重新计划"
+"!" = "重要"
+"?" = "问题"
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "注意"

diff --git a/i18n/zh-TW.toml b/i18n/zh-TW.toml
@@ -177,6 +177,18 @@ warning = "警告"
 caution = "小心"
 # === GitHub Alert ===
 
+# === Task lists ===
+[taskList]
+" " = "未完成"
+"x" = "已完成"
+"/" = "進行中"
+"-" = "已取消"
+"<" = "已計劃"
+">" = "已重新計劃"
+"!" = "重要"
+"?" = "問題"
+# === Task lists ===
+
 # === shortcodes/admonition.html ===
 [admonition]
 note = "注意"

diff --git a/layouts/partials/function/checkbox.html b/layouts/partials/function/checkbox.html
diff --git a/layouts/partials/function/content.html b/layouts/partials/function/content.html
@@ -14,7 +14,7 @@
     {{- $content = partial "function/fontawesome.html" $content -}}
   {{- end -}}
 
-  {{- $content = partial "function/checkbox.html" $content -}}
+  {{- $content = partial "function/task-lists.html" $content -}}
 
   {{- $content = partial "function/escape.html" $content -}}