😮更新配置信息及其解释

conf.yaml

@@ -1,17 +1,19 @@
 # 爬虫相关配置
-#   enable 是否启用爬虫
+# 解释：使用request实现友链文章爬取，并放置到根目录的all.json下
-#   json_url 请填写对应格式json的地址，仅支持网络地址
+#   enable:             是否启用爬虫
-#   article_count 请填写每个博客需要获取的最大文章数量
+#   json_url:           请填写对应格式json的地址，仅支持网络地址
+#   article_count:      请填写每个博客需要获取的最大文章数量
 spider_settings:
   enable: true
   json_url: "https://blog.qyliu.top/friend.json"
   article_count: 5
 
-# 邮箱推送功能配置，还没实现
+# 邮箱推送功能配置，暂未实现，等待后续开发
-#   enable 是否启用邮箱推送功能
+# 解释：每天为指定邮箱推送所有友链文章的更新，仅能指定一个
-#   to_email 收件人邮箱地址
+#   enable:             是否启用邮箱推送功能
-#   subject 邮件主题
+#   to_email:           收件人邮箱地址
-#   body_template 邮件正文的 HTML 模板文件
+#   subject:            邮件主题
+#   body_template:      邮件正文的 HTML 模板文件
 email_push:
   enable: false
   to_email: recipient@example.com
@@ -19,10 +21,11 @@ email_push:
   body_template: "rss_template.html"
 
 # 邮箱issue订阅功能配置
-#   enable 是否启用邮箱推送功能
+# 解释：向在issue中提取的所有邮箱推送您网站中的更新，添加邮箱和删除邮箱均通过添加issue对应格式实现
-#   github_username GitHub 用户名
+#   enable:             是否启用邮箱推送功能
-#   github_repo GitHub 仓库名
+#   github_username:    GitHub 用户名，用于构建issue api地址
-#   your_blog_url 你的博客地址
+#   github_repo:        GitHub 仓库名，用于构建issue api地址
+#   your_blog_url:      你的博客地址
 rss_subscribe:
   enable: true
   github_username: willow-god
@@ -30,10 +33,11 @@ rss_subscribe:
   your_blog_url: https://blog.qyliu.top/
 
 # SMTP 配置
-#   email 发件人邮箱地址
+# 解释：使用其中的相关配置实现上面两种功能，若无推送要求可以不配置，请将以上两个配置置为false
-#   server SMTP 服务器地址
+#   email:              发件人邮箱地址
-#   port SMTP 端口号
+#   server：            SMTP 服务器地址
-#   use_tls 是否使用 tls 加密
+#   port：              SMTP 端口号
+#   use_tls：           是否使用 tls 加密
 smtp:
   email: whutliu@yeah.net
   server: smtp.yeah.net