chore: update docs and style (#269)

2020-04-28 01:38:22 +08:00
parent b46c81053f
commit 6805d695f6
69 changed files with 540 additions and 454 deletions
--- a/layouts/_default/baseof.html
+++ b/layouts/_default/baseof.html
@@ -1,10 +1,12 @@
 {{- $version := "0.2.X" -}}

 {{- /* LoveIt theme version detection */ -}}
-{{- if not .Site.Params.version -}}
-    {{- errorf "\n\nYou haven't configured the LoveIt version param correctly yet. See https://hugoloveit.com/theme-documentation-basics/#basic-configuration \n你还没有正确配置 LoveIt 的版本参数 参考 https://hugoloveit.com/zh-cn/theme-documentation-basics/#basic-configuration \n" -}}
-{{- else if ne .Site.Params.version $version -}}
-    {{- errorf (printf "\n\n%s -> %s:\nYou have an incompatible update. See https://github.com/dillonzq/LoveIt/releases \n你进行了一次不兼容的更新 参考 https://github.com/dillonzq/LoveIt/releases \n" .Site.Params.version $version) -}}
+{{- if eq .Site .Sites.First -}}
+    {{- if not .Site.Params.version -}}
+        {{- errorf "Configuration Error 配置文件错误\n\nYou haven't configured the LoveIt version param correctly yet. See https://hugoloveit.com/theme-documentation-basics/#basic-configuration\n你还没有正确配置 LoveIt 的版本参数. 参考 https://hugoloveit.com/zh-cn/theme-documentation-basics/#basic-configuration\n" -}}
+    {{- else if ne .Site.Params.version $version -}}
+        {{- errorf (printf "Compatibility Error 兼容性错误\n\n%s -> %s:\nYou have an incompatible update. See https://github.com/dillonzq/LoveIt/releases\n你进行了一次不兼容的更新. 参考 https://github.com/dillonzq/LoveIt/releases\n" .Site.Params.version $version) -}}
+    {{- end -}}
 {{- end -}}

 {{- $params := .Params | merge .Site.Params.page -}}
@@ -15,6 +17,8 @@
    {{- .Scratch.Set "fingerprint" .Site.Params.fingerprint -}}
    {{- .Scratch.Set "analytics" .Site.Params.analytics -}}
    {{- .Scratch.Set "comment" $params.comment -}}
+{{- else if eq .Site .Sites.First -}}
+    {{- warnf "\n\nCurrent environment is \"development\". The \"comment system\", \"CDN\" and \"fingerprint\" will be disabled.\n当前运行环境是 \"development\". \"评论系统\", \"CDN\" 和 \"fingerprint\" 不会启用.\n" -}}
 {{- end -}}

 {{- .Scratch.Set "params" $params -}}
@@ -40,7 +44,7 @@
    <body>
        {{- /* Check theme isDark before body rendering */ -}}
        {{- $theme := .Site.Params.defaulttheme -}}
-        <script type="text/javascript">(window.localStorage && localStorage.getItem('theme') ? localStorage.getItem('theme') === 'dark' : ('{{ $theme }}' === 'auto' ? window.matchMedia('(prefers-color-scheme: dark)').matches : '{{ $theme }}' === 'dark')) && document.body.classList.add('dark');</script>
+        <script type="text/javascript">(window.localStorage && localStorage.getItem('theme') ? localStorage.getItem('theme') === 'dark' : ('{{ $theme }}' === 'auto' ? window.matchMedia('(prefers-color-scheme: dark)').matches : '{{ $theme }}' === 'dark')) && document.body.setAttribute('theme', 'dark');</script>

        <div id="mask"></div>

--- a/layouts/partials/assets.html
+++ b/layouts/partials/assets.html
@@ -122,7 +122,7 @@
 {{- if (.Scratch.Get "this").mermaid -}}
    {{- $source := $cdn.mermaidJS | default "lib/mermaid/mermaid.min.js" -}}
    {{- dict "source" $source "fingerprint" $fingerprint | dict "scratch" $.Scratch "data" | partial "scratch/script.html" -}}
-    {{- $options := dict "targetPath" "lib/mermaid/mermaid.min.css" -}}
+    {{- $options := dict "targetPath" "lib/mermaid/mermaid.min.css" "enableSourceMap" true -}}
    {{- dict "source" "lib/mermaid/mermaid.scss" "toCSS" $options "fingerprint" $fingerprint | dict "scratch" $.Scratch "data" | partial "scratch/stylesheet.html" -}}
 {{- end -}}

@@ -149,7 +149,7 @@
    {{- /* APlayer */ -}}
    {{- $source := $cdn.aplayerCSS | default "lib/aplayer/APlayer.min.css" -}}
    {{- dict "source" $source "fingerprint" $fingerprint | dict "scratch" $.Scratch "data" | partial "scratch/stylesheet.html" -}}
-    {{- $options := dict "targetPath" "lib/aplayer/dark.min.css" -}}
+    {{- $options := dict "targetPath" "lib/aplayer/dark.min.css" "enableSourceMap" true -}}
    {{- dict "source" "lib/aplayer/dark.scss" "toCSS" $options "fingerprint" $fingerprint | dict "scratch" $.Scratch "data" | partial "scratch/stylesheet.html" -}}
    {{- $source := $cdn.aplayerJS | default "lib/aplayer/APlayer.min.js" -}}
    {{- dict "source" $source "fingerprint" $fingerprint | dict "scratch" $.Scratch "data" | partial "scratch/script.html" -}}
@@ -172,7 +172,7 @@
 </script>

 {{- /* Polyfill.io */ -}}
-{{- partial "plugin/script.html" (dict "source" "https://polyfill.io/v3/polyfill.min.js?features=Element.prototype.closest%2CrequestAnimationFrame%2CCustomEvent%2CPromise%2CObject.entries%2CObject.assign%2CObject.values%2Cfetch%2CElement.prototype.after") -}}
+{{- partial "plugin/script.html" (dict "source" "https://polyfill.io/v3/polyfill.min.js?features=Element.prototype.closest%2CrequestAnimationFrame%2CCustomEvent%2CPromise%2CObject.entries%2CObject.assign%2CObject.values%2Cfetch%2CElement.prototype.after%2CArray.prototype.fill%2CIntersectionObserver%2CArray.from%2CArray.prototype.find%2CMath.sign") -}}

 {{- range (.Scratch.Get "this").script -}}
    {{- partial "plugin/script.html" . -}}
--- a/layouts/partials/comment.html
+++ b/layouts/partials/comment.html
@@ -31,6 +31,8 @@
        {{- /* Valine Comment System */ -}}
        {{- if $comment.valine.enable -}}
            <div id="valine" class="comment"></div>
+            {{- $options := dict "targetPath" "lib/valine/valine.min.css" -}}
+            {{- dict "source" "lib/valine/valine.scss" "toCSS" $options | dict "scratch" $.Scratch "data" | partial "scratch/stylesheet.html" -}}
            {{- $source := $cdn.valineJS | default "lib/valine/Valine.min.js" -}}
            {{- dict "source" $source "fingerprint" $fingerprint | dict "scratch" $.Scratch "data" | partial "scratch/script.html" -}}
            {{- $commentConfig = dict "el" "#valine" "appId" $comment.valine.appId "appKey" $comment.valine.appKey "lang" ($comment.valine.lang | default (T "valineLang")) "visitor" $comment.valine.visitor "recordIP" $comment.valine.recordIP "placeholder" ($comment.valine.placeholder | default (T "valinePlaceholder")) | dict "valine" | merge $commentConfig -}}
--- a/layouts/partials/head/link.html
+++ b/layouts/partials/head/link.html
@@ -37,7 +37,7 @@
 {{- /* style.min.css */ -}}
 {{- $stylesheet := dict "source" "css/style.template.scss" "fingerprint" $fingerprint -}}
 {{- $targetPath := cond .Site.IsMultiLingual (printf "css/style.%s.min.css" .Language.Lang) "css/style.min.css" -}}
-{{- $options := dict "targetPath" $targetPath "includePaths" (slice "config/css") -}}
+{{- $options := dict "targetPath" $targetPath "includePaths" (slice "config/css") "enableSourceMap" true -}}
 {{- $stylesheet = dict "template" "style.scss" "context" . "toCSS" $options | merge $stylesheet -}}
 {{- partial "plugin/stylesheet.html" $stylesheet -}}

--- a/layouts/partials/plugin/stylesheet.html
+++ b/layouts/partials/plugin/stylesheet.html
@@ -9,7 +9,7 @@
            {{- $res = $res | resources.ExecuteAsTemplate . $.context -}}
        {{- end -}}
        {{- with .toCSS -}}
-            {{- $options := . | merge (dict "outputStyle" "compressed" "enableSourceMap" true) -}}
+            {{- $options := . | merge (dict "outputStyle" "compressed") -}}
            {{- $res = $res | toCSS $options -}}
        {{- end -}}
        {{- if .minify -}}
--- a/layouts/posts/single.html
+++ b/layouts/posts/single.html
@@ -70,7 +70,7 @@
            <div class="details toc" id="toc-static">
                <div class="details-summary toc-title">
                    <span>{{ T "contents" }}</span>
-                    <span><i class="details-icon fas fa-angle-down"></i></span>
+                    <span><i class="details-icon fas fa-angle-right"></i></span>
                </div>
                <div class="details-content toc-content" id="toc-content-static">
                    {{- dict "content" .TableOfContents "ruby" $params.ruby "fraction" $params.fraction "fontawesome" $params.fontawesome | partial "function/content.html" | safeHTML -}}
--- a/layouts/shortcodes/admonition.html
+++ b/layouts/shortcodes/admonition.html
@@ -1,59 +1,41 @@
 {{- $inner := .Inner | .Page.RenderString -}}

-{{- $iconMap := dict "note" "fas fa-pencil-alt" -}}
-{{- $iconMap  = dict "abstract" "fas fa-list-ul" | merge $iconMap -}}
-{{- $iconMap  = dict "info" "fas fa-info-circle" | merge $iconMap -}}
-{{- $iconMap  = dict "tip" "fas fa-lightbulb" | merge $iconMap -}}
-{{- $iconMap  = dict "success" "fas fa-check-circle" | merge $iconMap -}}
-{{- $iconMap  = dict "question" "fas fa-question-circle" | merge $iconMap -}}
-{{- $iconMap  = dict "warning" "fas fa-exclamation-triangle" | merge $iconMap -}}
-{{- $iconMap  = dict "failure" "fas fa-times-circle" | merge $iconMap -}}
-{{- $iconMap  = dict "danger" "fas fa-skull-crossbones" | merge $iconMap -}}
-{{- $iconMap  = dict "bug" "fas fa-bug" | merge $iconMap -}}
-{{- $iconMap  = dict "example" "fas fa-list-ol" | merge $iconMap -}}
-{{- $iconMap  = dict "quote" "fas fa-quote-right" | merge $iconMap -}}
-{{- $iconDetails := "fas fa-angle-down" -}}
+{{- $iconMap := dict "note" "fas fa-pencil-alt fa-fw" -}}
+{{- $iconMap  = dict "abstract" "fas fa-list-ul fa-fw" | merge $iconMap -}}
+{{- $iconMap  = dict "info" "fas fa-info-circle fa-fw" | merge $iconMap -}}
+{{- $iconMap  = dict "tip" "fas fa-lightbulb fa-fw" | merge $iconMap -}}
+{{- $iconMap  = dict "success" "fas fa-check-circle fa-fw" | merge $iconMap -}}
+{{- $iconMap  = dict "question" "fas fa-question-circle fa-fw" | merge $iconMap -}}
+{{- $iconMap  = dict "warning" "fas fa-exclamation-triangle fa-fw" | merge $iconMap -}}
+{{- $iconMap  = dict "failure" "fas fa-times-circle fa-fw" | merge $iconMap -}}
+{{- $iconMap  = dict "danger" "fas fa-skull-crossbones fa-fw" | merge $iconMap -}}
+{{- $iconMap  = dict "bug" "fas fa-bug fa-fw" | merge $iconMap -}}
+{{- $iconMap  = dict "example" "fas fa-list-ol fa-fw" | merge $iconMap -}}
+{{- $iconMap  = dict "quote" "fas fa-quote-right fa-fw" | merge $iconMap -}}
+{{- $iconDetails := "fas fa-angle-right fa-fw" -}}

 {{- if .IsNamedParams -}}
    {{- $type := .Get "type" | default "note" -}}
-    {{- if .Get "details" -}}
-        <div class="details admonition {{ $type }}">
-            <div class="details-summary admonition-title">
-                <i class="icon {{ index $iconMap $type | default (index $iconMap "note") }}"></i>{{ .Get "title" | default (T $type) }}<i class="details-icon {{ $iconDetails }}"></i>
-            </div>
-            <div class="details-content">
-                <div class="admonition-content">
-                    {{- $inner -}}
-                </div>
-            </div>
+    <div class="details admonition {{ $type }}{{ if .Get `open` | ne false }} open{{ end }}">
+        <div class="details-summary admonition-title">
+            <i class="icon {{ index $iconMap $type | default (index $iconMap "note") }}"></i>{{ .Get "title" | default (T $type) }}<i class="details-icon {{ $iconDetails }}"></i>
        </div>
-    {{- else -}}
-        <div class="admonition {{ $type }}">
-            <div class="admonition-title"><i class="icon {{ index $iconMap $type | default (index $iconMap "note") }}"></i>{{ .Get "title" | default (T $type) }}</div>
+        <div class="details-content">
            <div class="admonition-content">
                {{- $inner -}}
            </div>
        </div>
-    {{- end -}}
+    </div>
 {{- else -}}
    {{- $type := .Get 0 | default "note" -}}
-    {{- if .Get 2 -}}
-        <div class="details admonition {{ $type }}">
-            <div class="details-summary admonition-title">
-                <i class="icon {{ index $iconMap $type | default (index $iconMap "note") }}"></i>{{ .Get 1 | default (T $type) }}<i class="details-icon {{ $iconDetails }}"></i>
-            </div>
-            <div class="details-content">
-                <div class="admonition-content">
-                    {{- $inner -}}
-                </div>
-            </div>
+    <div class="details admonition {{ $type }}{{ if .Get 2 | ne false }} open{{ end }}">
+        <div class="details-summary admonition-title">
+            <i class="icon {{ index $iconMap $type | default (index $iconMap "note") }}"></i>{{ .Get 1 | default (T $type) }}<i class="details-icon {{ $iconDetails }}"></i>
        </div>
-    {{- else -}}
-        <div class="admonition {{ $type }}">
-            <div class="admonition-title"><i class="icon {{ index $iconMap $type | default (index $iconMap "note") }}"></i>{{ .Get 1 | default (T $type) }}</div>
+        <div class="details-content">
            <div class="admonition-content">
                {{- $inner -}}
            </div>
        </div>
-    {{- end -}}
+    </div>
 {{- end -}}
--- a/layouts/shortcodes/style.html
+++ b/layouts/shortcodes/style.html
@@ -2,7 +2,7 @@
 {{- $id := partial "function/id.html" (dict "content" $content) -}}
 {{- $tag := .Get 1 | default "div" -}}
 {{- $style := .Get 0 | printf "#%s{%s}" $id -}}
-{{- $res := resources.FromString "css/shortcode/style.scss" $style -}}
-{{- $res = $res | toCSS (dict "targetPath" "css/shortcode/style.css" "outputStyle" "compressed") -}}
+{{- $res := resources.FromString (printf "temp/%s.scss" $id) $style -}}
+{{- $res = $res | toCSS (dict "targetPath" (printf "temp/%s.css" $id)) -}}
 {{- printf `<%s id="%s">%s</%s>` $tag $id $content $tag | safeHTML -}}
 <style>{{ $res.Content | safeCSS }}</style>