Front Matter 规范
所有文档必须包含统一的 Front Matter 元信息，确保内容可被检索、归类和管理。
字段定义
| 字段 | 必填 | 类型 | 说明 | 示例 |
|---|---|---|---|---|
title | ✅ | string | 文章标题 | Flink 架构原理 |
articleId | ✅ | string | 全局唯一编号 | 20240701-01 |
status | ✅ | enum | 文档状态 | draft / review / published / deprecated |
author | ✅ | string | 作者标识 | ljdou |
category | ✅ | string | 技术分类 | bigdata / cloud-native / backend / frontend / ai / architecture / notes |
description | 推荐 | string | 文章摘要，用于 SEO 和搜索预览 | 深入解析 Flink Checkpoint 机制 |
series | 推荐 | string | 所属专题，关联同系列文章 | Flink 深入系列 |
tags | 推荐 | string[] | 标签列表 | [Flink, Checkpoint, 流计算] |
created | ✅ | date | 创建日期 | 2024-07-01 |
updated | ✅ | date | 最后更新日期 | 2024-07-15 |
outline | 推荐 | number[] | 页面大纲显示层级 | [2, 3] |
category 枚举值
| 值 | 对应目录 | 说明 |
|---|---|---|
bigdata | docs/bigdata/ | 大数据 |
cloud-native | docs/cloud-native/ | 云原生 |
backend | docs/backend/ | 后端开发 |
frontend | docs/frontend/ | 前端开发 |
ai | docs/ai/ | 人工智能 |
architecture | docs/architecture/ | 架构设计 |
notes | docs/notes/ | 学习笔记 |
status 枚举值
| 值 | 说明 |
|---|---|
draft | 草稿，内容未完成 |
review | 审核中 |
published | 已发布，内容定稿 |
deprecated | 已废弃 |
series 专题
series 字段用于将多篇文章串联为一个系列。同一系列内的文章会在侧边栏自动关联。
| 示例 series 值 | 包含文章 |
|---|---|
Flink 深入系列 | 架构原理、Checkpoint、性能调优 |
Kubernetes 实战系列 | 架构、部署、排障 |
Go 后端实践 | Gin 框架、项目结构 |
完整示例
yaml
---
title: Flink Checkpoint 机制详解
articleId: 20240701-01
status: published
author: ljdou
category: bigdata
series: Flink 深入系列
description: 深入解析 Flink Checkpoint 的原理、Barrier 对齐机制与状态后端选型
tags: [Flink, Checkpoint, 流计算]
created: 2024-07-01
updated: 2024-07-15
outline: [2, 3]
---