示例项目
返回项目列表
示例项目
计划中文档指南
本文档介绍项目集合的 Frontmatter 字段与状态键值,供你在 src/content/projects/ 下编写项目时参考。
项目展示页使用指南
在 src/content/projects/ 下新建一个 .md 或 .mdx 文件即可创建一个项目。正文就是项目 README,渲染在详情页底部;frontmatter 里的字段则用于列表卡片与详情页顶部展示。
Frontmatter 字段
| 字段 | 类型 | 说明 |
|---|---|---|
title | string | 必填。项目名称。 |
slug | string | 可选,和文章一样使用。 |
published | date | 必填。发布/更新日期,如 2025-10-01。用于排序(配合 order)。 |
draft | boolean | 可选,默认 false。设为 true 时生产构建会隐藏该页,预览可见。 |
order | number | 可选。手动排序权重,越大越靠前;未设置则按 published 降序。 |
description | string | 可选。卡片简介 + 详情页描述。 |
image | string | 可选。封面图。支持完整 URL、公共根路径(/images/xxx.png)、相对路径(相对本文件目录,如 images/xxx.png)。留空则不显示封面。 |
tags | string[] | 可选。标签,列表页与详情页显示为 #标签。 |
link | array | 可选。外链按钮数组:{ label, icon, value }。icon 可用 astro-icon 名(如 fa7-brands:github)、图片 URL,或留空用 label 首字母。 |
status | string | 可选。项目状态,用标准 key(见下表)。 |
lang | string | 可选。页面语言,如 zh_CN。 |
完整示例
---title: "Firefly"slug: fireflypublished: 2025-10-01draft: falseorder: 100description: "一个功能丰富的开源博客主题。"image: "images/firefly.avif"status: "published"tags: - Astro - Sveltelink: - label: "GitHub" icon: "fa7-brands:github" value: "https://github.com/CuteLeaf/Firefly" - label: "文档" icon: "material-symbols:menu-book" value: "https://docs-firefly.cuteleaf.cn"lang: ""---状态键值(status)
status 使用标准 key,前台会按站点语言显示本地化文案,并按状态自动配色 + 图标:
| key | 含义 | 本地化示例 |
|---|---|---|
planning | 计划中 | 计划中 / Planning |
developing | 开发中 | 开发中 / In Development |
published | 已发布 | 已发布 / Published |
archived | 已归档 | 已归档 / Archived |
- 只写标准 key 即可:
status: "published"。 - 未知或自定义字符串会原样显示(中性灰),且不参与列表页的状态筛选。
列表页顶部支持按状态筛选(全部 / 各状态),并可按名称、描述、标签搜索项目。







