新闻指南

使用丰富的格式和元数据撰写并发布新闻文章。

创建文章

news/ 目录下新建 .md 文件:

news/my-first-post.md

Frontmatter

每篇新闻文章顶部需要 YAML frontmatter:

yaml
---
title: 我的第一篇文章
date: 2026-06-05
author:
  name: 你的名字
  avatar: /background/bgbtn.png
  tags:
    - text: 公告
      color: '#fff'
      bg: '#d84b4b'
cover: /background/44.jpg
category: 综合
---
字段必填描述
title文章标题
date发布日期(YYYY-MM-DD)
author.name作者显示名称
author.avatar作者头像图片路径
author.tags标签徽章(text、color、bg)
cover封面图路径
category文章分类标签
brief卡片简短描述,用于新闻列表自动生成
draft设为 true 时,生产构建从列表排除(开发环境仍可见)

草稿

设置 draft: true 可在开发时预览文章,构建时自动从新闻列表隐藏:

yaml
---
title: 未完成的文章
date: 2026-07-01
brief: 还在写……
draft: true
---

准备发布时,移除 draft 行或将值改为 false

添加到新闻列表

创建文章后,确保 frontmatter 中包含 brief 字段,文章将自动出现在新闻列表页:

yaml
---
title: 我的第一篇文章
date: 2026-06-05
cover: /background/44.jpg
brief: 显示在卡片预览中的简短描述。
---

新闻列表按 date 降序自动排列,无需手动编辑 news/index.md

NewsCard 组件参考

以下为 NewsCard 组件的属性表(自动生成时无需手动使用,供了解接口参考):

属性描述
title卡片标题
brief简短描述文字
image卡片背景图片
link文章链接
button-text按钮文字(默认 '阅读更多'

Markdown 功能

VitePress 支持完整的 Markdown 及其扩展语法:

代码块

ts
const greeting = '你好,世界!'
console.log(greeting)

提示块

TIP

这是一条有用的提示。

WARNING

这是一条警告。

DANGER

这是一条危险警告。

图片

md
![替代文字](/path/to/image.png)

表格

表头 1表头 2表头 3
行 1数据更多
行 2数据更多

链接

md
[内部链接](/docs/quick-start)
[外部链接](https://example.com)

提示

  • 使用 16:9 宽高比的 cover 图片效果最佳
  • brief 描述控制在 150 字以内,保持卡片布局整洁
  • 新闻文章按 date 排序 — 使用 ISO 格式(YYYY-MM-DD