메뉴
把源代码仓库转换为符合 OKF v0.1 的知识包(bundle), 用一套代码表示约定(类型词表, language/symbol/signature 字段, 行号锚点, 有类型链接)弥补 OKF 对代码的薄弱支持. 适用场景包括为代码库生成 agent 可读的知识文档, 把仓库的模块函数类整理为概念库, 建立代码知识图谱. 当用户提到 code to okf, 代码库转 OKF, 为代码生成知识, 或把仓库变成 agent 可检索的知识时触发.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
把 GitHub 上的 awesome-xx 精选列表转换并富化为符合 OKF v0.1 的知识包(bundle), 让社区海量教程和资源列表成为 AI 智能体可检索的知识. 适用场景包括把某个 awesome 列表导入为 OKF, 为列表里的条目补充结构化正文, 校验产物符合性. 当用户提到 awesome 列表, GitHub 精选列表转 OKF, 或想把某个 awesome-xx 变成知识库时触发.
把符合 OKF v0.1 的知识包或项目发布为可视化的文档站(VitePress, Vue 系, 亮色主题), 带侧边栏导航与概念互链. 适用场景包括把一个 OKF bundle 变成可浏览的网站或电子书, 为知识库生成文档门户, 把任意 OKF 项目发布为静态站点. 当用户提到把 OKF 发布成文档站, OKF 转网站或电子书, 可视化知识库, 或为 bundle 生成 docs 站时触发.
把长文, 书稿, 讲义或系列文章拆解为符合 OKF v0.1 的知识包(bundle), 按章节, 概念, 人物, 术语建立互链的概念页. 适用场景包括把一本书或长文档转成结构化知识库, 为写作素材建立可检索的概念网络, 把教程系列整理为 OKF. 当用户提到把书或长文转成 OKF, 拆书, 建立读书知识库, 或为书稿建概念库时触发.
把一个 GitHub 仓库(远程或本地)转换并富化为符合 OKF v0.1 的知识包(bundle), 让仓库的文档与代码成为 AI 智能体可检索的知识. 适用场景包括为开源项目生成知识库, 把代码仓库变成 agent 可问答的上下文, 建立仓库的架构与 API 知识图谱. 当用户提到 github to okf, 把仓库转 OKF, 为某个 repo 生成知识库, 或导入某个 GitHub 项目为知识时触发.
把任意输入(代码库, 文档, 数据表结构, 笔记)梳理成符合开放知识格式(OKF v0.1)的知识包(bundle), 强调正文质量而不只是结构合规. 适用场景包括从零创建 OKF 知识库, 为代码库生成知识文档, 把零散资料整理为可被 AI 智能体消费的 Markdown 概念库, 校验和修复 bundle 的符合性. 当用户提到 OKF, 开放知识格式, 知识包, knowledge bundle, 或需要把资料整理成 agent 可读的结构化知识时触发.
把符合 OKF v0.1 的知识包打包成单个自包含且经过压缩(minify)的 HTML 文件, 内嵌导航, Markdown 阅读器与概念关系图谱, 数据不出页面, 无需后端. 适用场景包括把 OKF bundle 变成一个可分享的单文件网页, 离线浏览知识库, 生成对标官方 viz.html 的可视化. 当用户提到 okf to web, OKF 转单文件网页, 可视化 OKF, minify 知识库, 或要一个自包含 HTML 时触发.
| name | code-to-okf |
| description | 把源代码仓库转换为符合 OKF v0.1 的知识包(bundle), 用一套代码表示约定(类型词表, language/symbol/signature 字段, 行号锚点, 有类型链接)弥补 OKF 对代码的薄弱支持. 适用场景包括为代码库生成 agent 可读的知识文档, 把仓库的模块函数类整理为概念库, 建立代码知识图谱. 当用户提到 code to okf, 代码库转 OKF, 为代码生成知识, 或把仓库变成 agent 可检索的知识时触发. |
| type | Skill |
| title | Code to OKF |
| lang | zh |
| tags | ["okf","code","代码","skill","提案"] |
| license | MIT |
把源代码仓库转换为 OKF 知识包。OKF 原生对代码支持薄弱(见支持度调研),本 Skill 用一套向后兼容的代码表示约定补齐——详见 references/code-okf-conventions.md。
type 用统一词表:Repository | Package | Module | Class | Function | Interface | Config | Script | Notebook。
不要逐文件粗暴转储。按知识价值取舍:先覆盖架构、公共 API、核心算法、易踩坑处,而非每个 getter。
---
type: Function
title: parse_frontmatter
description: 解析 Markdown 头信息,返回 (meta, body)。
resource: https://github.com/owner/repo/blob/<sha>/path.py#L20-L48 # 带行号锚点
language: python
symbol: module.parse_frontmatter
signature: "parse_frontmatter(text: str) -> tuple[dict, str]"
lang: zh
---
# Signature # 签名(代码块)
# Behavior # 行为:参数、返回、副作用、异常、复杂度
# Calls # 调用了谁(有类型链接)
# Cited by # 被谁调用
# Examples # 最小用例
用前缀表达关系,人读友好且可被简单规则机读:
- calls: [helper](/functions/helper.md)
- depends-on: [pyyaml](/packages/pyyaml.md)
- implements: [Reader](/interfaces/reader.md)
- deprecated-by: [parse_v2](/functions/parse_v2.md)
Repository 总览 + 各 Package/Module 概念,描述职责与依赖。Class/Function(公共 API、核心逻辑、复杂处)。language/symbol/signature/带锚点的 resource)+ 结构化正文 + 有类型链接。Calls/Cited by 互链,形成调用/依赖图谱。../okf-creator/scripts/validate_okf.py。okf-to-book 出文档站。resource 行号锚点用提交 SHA 而非分支名,避免代码变动后失效;