文档 / 指南

指南

七章,从一段空目录出发,到你写出一个可用的多页外壳。
读完它,你会知道 brk 是什么、为什么这样设计,以及什么时候不该用它。

// 只想先跑起来

如果你不打算通读,只想尽快看到第一张卡片渲染出来——直接跳到第 01 章。五步,十分钟。

从快速开始进入 →
// 三条阅读路径

完整读一遍

约 40 分钟 · 推荐

按顺序读完。既能上手,也能理解背后的取舍,以及它对你项目的适配度。

只想写页面

约 15 分钟 · 最短路径
01 03 04

快速开始 + JSX 语法 + 页面契约。知道这三章就足够写出可用的页面。

先想清楚为什么

约 20 分钟 · 面向选型
02 05 07

设计哲学 + 渲染与更新 + 多页容器。看完你就能判断 brk 是否适合你的项目。

// 读完之后

你会拥有这些

  • 一个可运行的最小 brk 项目,知道每个文件的作用
  • 能独立写出一个完整页面,包括状态更新与异步加载
  • 能搭一个多页外壳,在多个子页面之间切换
  • 能判断 brk 是否适合当下项目,以及为什么
  • 知道哪些事该自己做,哪些事 brk 会替你兜底
  • 遇到 brk.* 的 API 时能猜到它大概怎么实现
// 阅读前提

开始之前,假设你已经会这些

  • 能读懂 JavaScript / TypeScript 基本语法
  • 知道 JSX 大致长什么样(或读过 React 文档)
  • 会一点 esbuild,或愿意现学三条配置
  • 理解 import() 动态加载模块是什么