跳到內容

pi-better-show 參考

README 背後的完整契約:每一種區塊、core、server、元素與 React 的 API,以及 show_doc extension 的細節。請找到需要的那一節,其餘可以略過。

pi-better-show 是一套區塊詞彙:每個負責繪製它的宿主,共用同一個剖析器、同一套純文字備援和同一種答案編碼。pi extension 是這樣的宿主之一,GUI 或聊天橋接也可以是另一個。

pi-better-show core: isomorphic, no DOM, no node APIs; depends on `yaml` only
pi-better-show/elements browser: framework-free custom elements, one per block kind (no yaml, no node APIs)
pi-better-show/react thin React wrappers over the elements (React is an optional peer)
pi-better-show/server node: Mermaid to SVG and to Unicode text (beautiful-mermaid)
pi-better-show/extension the pi extension: `show_doc`, a loopback page server, edit mode, event-bus contract v2
進入點 作用 章節
pi-better-show 把 Markdown 剖析成區塊、寫成純文字、編碼並驗證答案。 區塊、Core API
pi-better-show/server 把 Mermaid 畫成 SVG 或 Unicode 文字。 Server API
pi-better-show/elements 把每種區塊畫成自訂元素,並觸發 pbs-answer。 元素
pi-better-show/react 為 React 包裝這些元素。 React
pi-better-show/extension show_doc 工具、頁面伺服器、編輯模式與事件匯流排。 pi extension

這個套件發布的是 TypeScript 原始碼,沒有建置步驟。原始碼只用可抹除的語法,所以能在 node 的型別剝除、bun 與打包工具的流程中載入。設計文件:docs/specs/2026-11-07-better-show/spec.md。