Documentation

结构化元数据 — 每次导出都是知识资产

YAML frontmatter 将你的 Markdown 导出从简单文本文件转化为结构化、可查询的知识资产。每个文件携带丰富的元数据,使其在 Obsidian、Notion 和其他 PKM 工具中可搜索。

什么是 YAML Frontmatter?

YAML frontmatter 是 Markdown 文件顶部的一块结构化元数据,由 --- 标记包裹:

yaml
---
title: "使用 FastAPI 构建 REST API"
tags: [python, fastapi, rest-api, backend]
summary: "使用 FastAPI 创建 RESTful API 的分步指南,包括身份验证和数据库集成。"
model: claude-3.5-sonnet
platform: claude
date: 2024-01-15
word_count: 3420
---

此元数据在渲染的 Markdown 中不可见,但可被 Obsidian Dataview 等工具读取,实现对知识库的强大查询。

完整的 YAML frontmatter 示例,包含所有字段
完整的 YAML frontmatter 示例,包含所有字段

可用字段

所有字段都可以在 设置 → 通用 → Frontmatter 中单独切换:

基本信息:

字段描述默认
标题自动生成的对话标题开启
对话 ID对话的唯一标识符开启
平台AI 平台名称(chatgpt、claude 等)开启
模型名称使用的 AI 模型(gpt-4、claude-sonnet-4 等)开启
源 URL指向原始对话的链接开启

时间信息:

字段描述默认
创建时间对话开始时间开启
更新时间对话最后更新时间开启
导出时间执行导出的时间开启

统计信息:

字段描述默认
消息数对话中的消息数量开启
字数总字数开启
内容类型内容类型(代码、图片、表格、引用)开启

AI 增强

字段描述默认
AI 标签AI 生成的话题标签关闭
AI 摘要AI 生成的对话摘要关闭

格式:

字段描述默认
日期格式ISO 8601 / 仅日期 / 本地ISO 8601
嵌入原生属性写入 PDF 文档属性或 Notion 数据库属性开启
Frontmatter 设置 — 基本信息组及开关
Frontmatter 设置 — 基本信息组及开关
Frontmatter 设置 — 时间信息组
Frontmatter 设置 — 时间信息组
Frontmatter 设置 — AI 增强组(功能)
Frontmatter 设置 — AI 增强组(功能)

每种导出类型的输出格式

Frontmatter 元数据可以 3 种格式输出,由 metaOutputFormat 设置控制:

输出格式语法用于
YAML Frontmatter---\nkey: value\n---Markdown (.md)
内联元数据**标签:** 值Notion、TXT/MD
纯文本标签: 值TXT

每种导出格式(Markdown、TXT、PDF、Word、JSON、Notion、剪贴板)都可以通过 Frontmatter 部分的 输出格式 开关独立启用或禁用元数据。

输出格式开关 — 按导出格式启用/禁用元数据
输出格式开关 — 按导出格式启用/禁用元数据

启用 YAML Frontmatter

YAML frontmatter 在启用 AI 标签与摘要时生成:

  1. 进入设置 → 通用 → 🔗 AI 服务商
  2. 选择服务商并输入 API 密钥
  3. 启用 AI 标签与摘要
  4. 导出为 Markdown — frontmatter 会自动包含

如果未启用 AI 标签,导出仍会在最小化的 frontmatter 块中包含基本元数据(日期、平台、模型)。

Frequently Asked Questions

可以单独切换 frontmatter 字段吗?+

可以。每个字段(标题、conversation_id、平台、模型、日期、字数、标签、摘要等)都可以在设置 → 通用 → Frontmatter 中单独开启/关闭。

有哪些日期格式可用?+

三种格式:ISO 8601(2024-01-15T10:00:00Z)、仅日期(2024-01-15)和本地(2024/01/15 10:00)。

frontmatter 会影响 Markdown 的渲染吗?+

不会。大多数 Markdown 渲染器默认隐藏 frontmatter。它是元数据,不是可见内容。

Related Articles