SuperAPI AI 工具集

creating-themes

通用与其它

查看项目

更新于 10-15 21:40

技能介绍

用途:为 @farming-labs/docs 创建自定义主题、扩展已有主题,或将其发布分享(如发布为 npm 包)。一般初始化与安装请参考 getting-started 技能。

主要能力:用 createTheme() 定义主题,配置 name 与 ui 下的 colors、typography、radius、layout、codeBlock、sidebar、card、components 等;用 extendTheme() 在内置预设(fumadocs、darksharp、pixelBorder、colorful、greentree、darkbold、shiny、ledger、shadcn、concrete、commandGrid、hardline)基础上扩展;也可从不同内置主题挑选默认值组合成混合主题。仅需设置想改的部分,其余继承。

使用方式:在 docs.config 中引入主题并调用,如 theme: myTheme();用户可覆盖,如 myTheme({ ui: { colors: { primary: "#3b82f6" } } })。注意 extendTheme() 返回主题实例而非工厂,需要可复用预设时用 createTheme()。发布为 npm 包时提供 src/index.ts 与可选 theme.css,package.json 中设置 exports 与 peerDependencies(@farming-labs/docs),用户通过 npm install 安装并在全局 CSS 中 @import 主题 CSS。

适用场景:让文档站视觉与主站一致、基于内置主题做变体、制作可分享主题。

限制:资料未提供具体版本要求、收费信息与效果保证;CSS 覆盖需参考官方文档的完整选择器与预设列表。