Skip to content

Apothic-AI/VIBE.md

Repository files navigation

VIBE.md Protocol

Developer-preview website and documentation hub for the Vibe model.

The site also publishes the live desktop demo for vibe-browser.

The project now focuses on:

  1. discovering VIBE.md
  2. reading its required sections
  3. resolving any optional integrations listed there
  4. optionally using llms.txt as a companion text index when a site publishes it

Stack

  • Vite + React + TypeScript
  • TailwindCSS
  • Cloudflare Worker for SPA and docs asset delivery

Getting Started

Install deps and run dev server:

pnpm install
pnpm dev

Open http://localhost:5173

Documentation

The public docs live in public/docs.

Primary reader flow:

  1. OVERVIEW.md
  2. VIBE.md
  3. DEVELOPER-GUIDE.md
  4. EXAMPLES.md
  5. INTEGRATIONS.md
  6. ASSET-BUNDLES.md
  7. SECURITY-PRIVACY.md

src/content/docs.ts controls how those docs are grouped and surfaced on the site.

Related Projects

  • vibe-browser - Tauri desktop client that discovers and renders VIBE.md

License

Apache License 2.0. See LICENSE.

Releases

No releases published

Packages

 
 
 

Contributors