From 51221f0f91b720a7c87c720ff0431a247958ab87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=87=A1=E6=A2=A6=E6=98=9F=E5=B0=98?= Date: Sun, 30 Oct 2022 21:12:01 +0800 Subject: [PATCH] :memo: Upgrade the README content about post front matter. --- README.md | 6 ++++-- README.zh.md | 5 +++-- archetypes/default.md | 8 ++++---- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6ffd465..edb6714 100644 --- a/README.md +++ b/README.md @@ -112,10 +112,12 @@ tags: #expand: true # It's means that will redirecting to external links #extlink: -# Switch to enabled or disabled comment plugins in this post +# Disabled comment plugins in this post #comment: # enable: false -# Enable table of content +# Disable table of content int this post +# Notice: By default will automatic build table of content +# with h2-h4 title in post and without other settings #toc: false # Absolute link for visit #url: "{{ lower .Name }}.html" diff --git a/README.zh.md b/README.zh.md index 5ee408e..32340ec 100644 --- a/README.zh.md +++ b/README.zh.md @@ -120,10 +120,11 @@ tags: #expand: true # 外部链接地址,访问时直接跳转 #extlink: -# 在当前页面开启或关闭评论功能 +# 在当前页面关闭评论功能 #comment: # enable: false -# 开启文章目录功能 +# 关闭当前页面目录功能 +# 注意:正常情况下文章中有H2-H4标题会自动生成目录,无需额外配置 #toc: false # 绝对访问路径 #url: "{{ lower .Name }}.html" diff --git a/archetypes/default.md b/archetypes/default.md index b317672..abed622 100644 --- a/archetypes/default.md +++ b/archetypes/default.md @@ -27,12 +27,12 @@ tags: # 外部链接地址,访问时直接跳转 # It's means that will redirecting to external links #extlink: -# 在当前页面开启或关闭评论功能 -# Switch to enabled or disabled comment plugins in this post +# 在当前页面关闭评论功能 +# Disabled comment plugins in this post #comment: # enable: false -# 开启文章目录功能 -# Enable table of content +# 关闭文章目录功能 +# Disable table of content #toc: false # 绝对访问路径 # Absolute link for visit