学习指南
OKF 教程
逐步学习 Open Knowledge Format：从理解基础知识到生成、验证和发布生产就绪的知识 bundle。
步骤 1：理解 OKF
Open Knowledge Format (OKF) 是一种轻量级方式，将知识打包为带 YAML frontmatter 的 Markdown 文件。每个 OKF 文件代表一个概念、API 端点、数据集、指标或文档片段。
frontmatter 包含结构化元数据（type、title、description、tags），而 Markdown 正文包含实际的知识内容。这使 OKF 既人类可读又机器可解析。
步骤 2：验证你的第一个文档
OKF 校验器检查你的文档结构并提供 OKF Score。从模板开始，将其粘贴到校验器中，看看它的得分如何。
校验器显示三个关键指标：结构（frontmatter 完整性）、覆盖度（内容深度）和连接性（链接和引用）。使用反馈来改进你的文档。
步骤 3：从网站生成 OKF
你可以从现有网页自动生成 OKF 文档。网页转 OKF 生成器支持三种模式：单个 URL、Sitemap（最多 20 页）或 URL 列表。
对于批量生成，工具会创建包含 index.md、生成日志、验证报告和单独概念文件的完整 bundle。你可以在处理所有 URL 之前预览第一页。
步骤 4：提高 OKF Score
高 OKF Score 意味着结构更好、更易发现的知识。以下是改进每个维度的方法：
- 结构（40 分）： 添加所有 frontmatter 字段：type（10分）、title（10分）、description（10分）、id（5分）、tags（5分）。
- 覆盖度（30 分）： 编写详细内容：非空正文（10分）、100+ 词（10分）、300+ 词（5分）、使用标题（5分）。
- 连接性（30 分）： 添加链接：source_url（10分）、内部链接（10分）、3+ 内部链接（10分）。
目标是生产就绪文档达到 90+ 分。使用 Live Badge 持续监控你已部署的 OKF 文档。
相关 OKF 工具与指南
FAQ
我需要了解 Markdown 吗？
基本的 Markdown 知识会有帮助，但 OKF 很简单：只需在 Markdown 文件顶部添加 YAML frontmatter。教程涵盖你需要的一切。
学习 OKF 需要多长时间？
你可以在 5-10 分钟内创建第一个有效的 OKF 文档。理解所有功能和最佳实践大约需要 30 分钟。
我应该从哪里开始？
从步骤 1 开始理解 OKF 是什么，然后在步骤 2 中使用校验器进行练习。步骤 3-4 展示如何生成和改进 OKF 文档。