okf-seedling
OKF v0.2 準拠の知識バンドルを作成する Quarto テンプレートツール
okf-seedling
Open Knowledge Format (OKF) v0.2 に準拠した 知識バンドル を、Quarto だけで作って公開するテンプレートツールです。
- エージェントにも人間にも読める
.qmdをソースに quarto use template一発でバンドル雛形を生成- レンダリングで 人間用HTML と 機械用OKFバンドル を二系統出力
- GitHub Pages / Cloudflare Pages に並行デプロイ
OKF バンドルとは
エージェントにも人間にも読める形で、ドキュメント群をひとまとめにした知識パッケージです。 okf/ ディレクトリ(index.md / log.md / concepts/*.md)に機械可読な Markdown として自動生成され、 人間向けの HTML と 同じ source(.qmd) から同時に出力されます。
- concept 単位で構造化 … API / Playbook / Metric / Attested Computation を 1 ファイル 1 概念で記述
- frontmatter が辞書 … type・対象・作成日などのメタ情報を機械が解釈
- sha 差分追跡 … バンドル全体の更新差分を機械が検知できる
Create
quarto use template <org>/okf-seedling で新しい知識バンドルを生成。詳細
Deploy
GitHub Pages と Cloudflare Pages に並行デプロイ。frontmatter は HTML にも出力され、Playwright による知識蓄積にも対応。詳細
Concept 型
| Type | 説明 |
|---|---|
| API Overview | API 全体の概要(認証・バージョン・エラー) |
| API Endpoint | 1 エンドポイントの仕様 |
| API Schema | 入出力の型・JSON スキーマ |
| Playbook | 手順書・対処手順 |
| Metric | 指標の定義 |
| Attested Computation | 検証可能な計算定義 |
Get Started
quarto use template <gh-org>/okf-seedling
quarto render
node tools/validate-okf.mjs