skills.rest
dhanesh
dhaneshCOMMUNITY
Explore all skills by this author →
Website𝕏@dhaneshpurohitGitHub

okf-site-kit

Generate a browsable Astro and Starlight static website from an OKF knowledge bundle.

1|Updated May 28, 2026
Search Tags:#documentation#markdown#knowledge base#astro#static site generator#Starlight#OKF
One-click install
npx skills add https://github.com/dhanesh/agent-skills --skill okf-site-kit-dhanesh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: okf-site-kit
Source: https://github.com/dhanesh/agent-skills/tree/main/okf-site-kit
Command: npx skills add https://github.com/dhanesh/agent-skills --skill okf-site-kit-dhanesh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires astro, @astrojs/starlight, @astrojs/markdown-remark, and includes references (resource) and assets (resource) components.

What problem does it solve? Open Knowledge Format (OKF) bundles are plain markdown plus YAML frontmatter with no required tooling, so there is no built-in way to browse or publish them. This Skill reads any OKF v0.1 bundle and emits a complete Astro + Starlight static-site project with search, navigation, and OKF-aware presentation. ## Core Features & Use Cases - Bundle-to-site generation: A stdlib-only Python generator scans concepts, reserved index.md/log.md files, nested directories, and non-markdown assets, then emits a full site with a hero landing page, one page per concept, and a changelog from log.md. - OKF metadata panels: Each concept page renders a color-coded type badge, tag chips, resource link, timestamp, and any producer-defined frontmatter keys, with internal links rewritten to site routes. - Tolerant conformance handling: Every observed bundle dialect (Google's sample bundles, spec-canonical bundles, producer-extended bundles) is supported, with spec violations degrading gracefully into WARN: reports instead of failures. - Use Case: You have a team knowledge bundle produced by an OKF producer and want to publish it to GitHub Pages. Run the generator with --base, --site, and --deploy-workflow, then npm install and npm run build to get a deploy-ready static site with full-text search and dark/light theming. ## Quick Start Ask the agent to generate a browsable website from your OKF knowledge bundle, for example: "Generate a site from my knowledge bundle at ./knowledge and prepare it for GitHub Pages."

Frequently Asked Questions about okf-site-kit

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a static site from an OKF knowledge bundle?▼

Run python3 assets/okf_site.py generate <bundle> --out <dir> with optional flags like --title and --tagline, then run npm install and npm run build in the output directory. The result is a complete Astro + Starlight project with the static site in dist/.

What is the Open Knowledge Format and how do I browse an OKF bundle?▼

OKF is Google's open spec representing knowledge as a directory of markdown files with YAML frontmatter, deliberately shipping no required tooling. This generator is the consumer side: it scans the bundle and emits a searchable, themed website with one page per concept.

Can I deploy an OKF-generated site to GitHub Pages?▼

Yes. Pass --base /<repo-name>, --site https://<user>.github.io, and --deploy-workflow when generating. The generator bakes the base path into the Astro config and emits a GitHub Actions workflow that builds and deploys on every push to main.

Does the generator handle OKF bundles with missing frontmatter or broken links?▼

Yes, per the spec's tolerant-consumer rules. Concepts without frontmatter or a type render as generic concepts with a WARN: report, broken links are left as authored and reported, and an empty directory fails inspect cleanly with INSPECT_RESULT: EMPTY.

What dependencies are required to build the generated Astro Starlight site?▼

Generation requires only python3 with the standard library, no pip or network. Building the emitted site requires Node.js 18+ with npm to install astro, @astrojs/starlight, and @astrojs/markdown-remark.

Related Skills

Explore More Software Engineering Skills→
inkeepinkeep
3.3k

open-knowledge-pack-okf

Create OKF v0.1 compliant knowledge bases with predefined folders and reserved files.

Official
Basic
mofa-orgmofa-org
11

mofa-publish

Deploy built static sites to GitHub Pages or Mac Mini hosting.

Official
Advanced
jeremybrasherjeremybrasher

broken-link-checker

Crawls websites to detect broken links and reports source pages for fixing.

Community
Basic
legioncodeinclegioncodeinc
84

docs-site-stinger

Selects, sets up, and maintains developer documentation sites across seven platforms.

Official
Advanced