How watanabe3tipapa/okf-seedling works
okf-seedling is a Quarto template for growing OKF knowledge bundles from concept documents. The main workflow is authoring .qmd concepts, rendering human-readable HTML and a machine-readable okf/ bundle, then checking the bundle for conformance and quality. Separate capabilities support browser-based editing, homepage previews, and optional extraction of rendered concepts into JSON knowledge records. The graph follows README-described workflows and sampled source; unsampled Quarto wiring and concept contents limit which internal render-time connections can be shown.
Main entry points: okf OKF bundle · learn.mjs Learning runner · _quarto.yml Quarto render · stamp-okf.mjs Bundle generator
Components 16
Authoring and rendering
- Concept documents
concepts - Quarto render
_quarto.yml - Human HTML site
- OKF metadata filter
_extensions/okf/okf-meta.lua
OKF bundle
- Bundle generator
tools/stamp-okf.mjs - OKF bundle
okf
Validation and previews
- Concept type registry
tools/okf-types.json - OKF validator
tools/validate-okf.mjs - Homepage preview injection
tools/gen-peek.mjs - Homepage preview data
Learning pipeline
- Learning runner
pipeline/src/learn.mjs - Concept extractor
pipeline/src/extract.mjs - Learned JSON records
Online editing
- Editor link generator
tools/editor-link.mjs - Quarto Editor PE
Other components
- Bundle author
Connections 16
- Concept documents → Quarto render: renders from
README.md - Quarto render → Human HTML site: generates HTML
README.md - Quarto render → OKF bundle: generates bundle
README.md - OKF metadata filter → Concept type registry: uses schema
- Bundle generator → Concept documents: reads concepts
tools/stamp-okf.mjs - Bundle generator → OKF bundle: writes bundle
tools/stamp-okf.mjs - OKF validator → OKF bundle: checks bundle
tools/validate-okf.mjs - OKF validator → Concept type registry: reads types
tools/validate-okf.mjs - Homepage preview injection → OKF bundle: reads concepts
tools/gen-peek.mjs - Homepage preview injection → Homepage preview data: injects preview
tools/gen-peek.mjs - Bundle author → Editor link generator: requests links
tools/editor-link.mjs - Editor link generator → Quarto Editor PE: prints edit links
tools/editor-link.mjs - Bundle author → Quarto Editor PE: edits and commits
README.md - Learning runner → Human HTML site: reads rendered concepts
pipeline/src/learn.mjs - Learning runner → Concept extractor: calls extractor
pipeline/src/learn.mjs - Learning runner → Learned JSON records: writes records
pipeline/src/learn.mjs