vercel-labs/json-render:README 來源編輯指南
根據 README、倉庫資料與授權整理 vercel-labs/json-render 的安裝與核驗路徑。
專案定位
vercel-labs/json-render 的 README 將專案描述為「The Generative UI framework」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「json-render」下寫到:Generate dynamic, personalized UIs from prompts without sacrificing reliability. Predefined components and actions for safe, predictable output.。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「Why json-render?」與相關條目,可以先判斷它是否處理你的實際問題:Predictable - JSON output matches your schema, every time。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:Guardrailed - AI can only use components in your catalog。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「3. Render AI-Generated Specs」等段落。可確認的線索包括:That's it. AI generates JSON, you render it safely.。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: # for React npm install @json-render/core @json-render/react # for React with pre-built shadcn/ui components npm install @json-render/shadcn # or for React Native npm install @json-render/core @json-render/react-native # or for video npm install @json-render/core @json-render/remotion # or for PDF documents npm install @json-render/core @json-render/react-pdf # or for HTML email npm install @json-render/core @json-render/react-email @react-email/components @react-email/render # or for Vue npm in 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「Why json-render?」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「Packages」段落提到:| Package | Description | | --------------------------- | ---------------------------------------------------------------------- | | @json-render/core | Schemas, catalogs, AI prompts, dynamic props, SpecStream utilities | |。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:Fast - Stream and render progressively as the model responds。