
你将构建的内容
- 含十六进制值的配色方案
- 字体系统(字体、字号、字重)
- 间距与布局规范
- Logo 与品牌图像
- 主题信息(浅色/深色模式)

前提条件
- 已安装 Node.js 18 或更高版本
- 拥有来自 firecrawl.dev 的 Firecrawl API 密钥
- 具备 TypeScript 和 Node.js 的基础知识
1
创建新的 Node.js 项目
首先,为项目创建一个新目录并完成初始化:将
package.json 更新为使用 ES 模块:package.json
2
安装依赖项
安装用于网页抓取和 PDF 生成的所需软件包:这些包提供:
@mendable/firecrawl-js: 用于从网站中提取品牌标识信息的 Firecrawl SDKpdfkit: PDF 文档生成库tsx: 用于在 Node.js 中运行 TypeScript 的工具
3
构建品牌风格指南生成器
在 将
index.ts 中创建主应用程序文件。该脚本会从指定 URL 提取品牌风格,并生成一份专业的 PDF 风格指南。index.ts
在这个简单项目中,API 密钥是直接写在代码里的。如果你计划将其推送到 GitHub 或与他人分享,请将密钥移动到
.env 文件中,并改用 process.env.FIRECRAWL_API_KEY。fc-YOUR-API-KEY 替换为你在 firecrawl.dev 获取的 Firecrawl API 密钥。代码解析
关键组件:- Firecrawl 品牌格式:
branding格式会提取完整的品牌标识信息,包括颜色、排版、间距和图片 - PDFKit 文档:创建带有合适页边距和章节结构的专业 A4 PDF
- 颜色色板:渲染带有十六进制值和语义名称的可视化色块
- 排版展示:以结构化布局展示字体系列和字号
- 间距与主题:记录设计系统的间距单位和配色方案
4
运行生成器
运行脚本生成品牌风格指南:该脚本将会:
- 使用 Firecrawl 的品牌格式规范,从目标 URL 中提取品牌识别信息
- 生成一个名为
brand-style-guide.pdf的 PDF - 将其保存在你的项目目录中
index.ts 中的 URL 常量。工作原理
提取流程
- URL 输入:生成器接收目标网站的 URL
- Firecrawl 抓取:调用
/scrape端点,并使用branding格式 - 品牌分析:Firecrawl 分析页面的 CSS、字体和视觉元素
- 返回数据:返回一个结构化的
BrandingProfile对象,其中包含所有设计 tokens
PDF 生成流程
- 页眉生成:使用主品牌色生成彩色页眉区域
- Logo 获取:下载并嵌入 logo 或网站图标(favicon,若有)
- 配色方案:将每种颜色渲染为带元数据的色块
- 排版信息:记录字体系列、字号和字重
- 间距信息:包含基础间距单位、圆角半径和主题模式
品牌配置结构
核心功能
自动颜色提取
- Primary & Secondary: 品牌主色与辅助色
- Accent: 强调色和 CTA 颜色
- Background & Text: 作为 UI 基础的背景色与文本色
- Semantic Colors: 表示成功、警告和错误状态的语义色
排版规范文档
- Font Families:主字体、标题字体和等宽字体
- Size Scale:所有标题和正文字号
- Font Weights:所有可用字重
视觉输出
- 与品牌配色相匹配的彩色页眉
- 在可用时嵌入品牌 Logo
- 具有清晰层级结构的专业版式
- 带有生成日期元数据的页脚

自定义方案示例
添加组件文档
导出多种 formats
批量处理
自定义 PDF 主题
最佳实践
- 处理缺失数据:并非所有网站都会暴露完整的品牌信息。务必为缺失的属性提供后备值(默认值)。
- 遵守速率限制:在批量处理多个站点时,在请求之间添加延迟,以遵守 Firecrawl 的速率限制。
- 缓存结果:将提取到的品牌数据进行缓存,避免针对同一站点重复调用 API。
- 处理图片格式:某些 Logo 可能采用 PDFKit 不支持的格式(例如 SVG)。考虑添加格式转换或设计优雅的降级方案。
- 错误处理:将生成流程包裹在 try-catch 块中,并提供有意义的错误信息。

