公告

记录一下自己学习和生活中的所见所闻

Skip to content

写文章常见配置项

参考教程

🔧 主题配置 - 首页&文章 | @sugarat/theme

image.png

hidden

用于设置文章是否出现在首页的列表里

md
---
hidden: true
---

readingTime

单独设置是否展示文章的预计阅读时间,全局配置开关见 article.readingTime

md

---
readingTime: true
---

date

  • type:string | false

单独设置文章的发布时间,不设置的情况下默认会通过Git取文件最后修改时间,设置为 false 则不会在文章页展示

md
---
date: 2023-01-04
---
md
---
date: 2023-01-08 20:00:00
---

展示规则,实现代码见:packages/theme/src/utils/index.ts

  • 小于1分钟:xx秒前
  • 小于1小时:xx分钟前
  • 小于1天:xx小时前
  • 小于1周:xx天前
  • 其它:按照实际时间展示 yyyy-MM-dd

recommend

  • type: number | false | string | string[] | [...string[], number]

可用于配置左侧推荐列表数据表现,默认只展示同级目录下的文章

  • 文章左侧展示的 推荐文章 顺序(越小越靠前)
  • 在推荐列表中隐藏掉不展示
  • 手动关联不同目录的文章进行展现
md
---
# 直接设置文章的关键词
recommend: 'Node.js'
# 设置多个关键词
recommend: ['Node.js', 'css', 'html']
# 设置关键词并设置顺序
recommend: ['Node.js', 'css', 'html', 1]
---

publish

  • type: false

表明文章是否发布,用于设置文章是否出现在首页和侧边栏里

md
---
publish: false
---

等价于

md
---
hidden: true
recommend: false
---

整合

md
---
title: 
tag: 
readingTime: true
recommend: ['markdown',1]
date: 2025-05-07 09:25:00
hidden: false
---