Skip to content

Frontmatter 约定 ​

内容页(非首页 layout: home)在文件最上方使用 YAML frontmatter。字段保持精简,方便内容同学只改 Markdown。

必填 ​

yaml
---
title: 数仓分层怎么落地
description: ODS→DWD→DWS→ADS:边界、表命名、依赖与验收清单
difficulty: 入门
prerequisites:
  - 熟悉常见离线数仓表与分区概念
  - 能读懂简单 Hive / Spark SQL
---
字段说明
title页面标题;与一级标题一致或更短
description一句话摘要,用于 SEO / 卡片
difficulty入门 / 进阶 / 架构 三选一
prerequisites字符串列表;读者开写前应具备的能力

可选 ​

yaml
---
outline: deep
status: draft   # draft | review | published;默认可不写
---
字段说明
outlineVitePress 右侧大纲深度;长文可用 deep
status协作状态;成稿经审校通过后再标 published(可选)

正文结构建议 ​

frontmatter 之后按固定骨架写,便于审校:

  1. ::: info 难度与前置 呼应 frontmatter(可读复述,勿矛盾)
  2. ## 适用场景(含不适用)
  3. ## 真实场景(一条即可)
  4. ## 怎么做 / 分步清单
  5. ## 常见坑
  6. ## 如何验收
  7. ## 相关面试题(占位链接即可;格式见 文末面试题占位规范)

示例见 数仓分层怎么落地。