SuperAPI AI 工具集

sidecar-website

前端与建站

查看项目

更新于 10-16 00:06

技能介绍

用途:维护 Sidecar 的 Docusaurus 文档站点,站点位于 website/ 目录,需 Node.js >= 20。

主要能力:管理 docs/ 文档页、blog/ 博客、src/pages 自定义 React 页面、src/components 组件、static/ 静态资源与图片;配置 docusaurus.config.js、sidebars.js;撰写 Markdown/MDX 文档与博客;调整样式与图标;构建与部署。

使用方式:cd website;首次 npm install;开发 npm start(http://localhost:3000);构建 npm run build(输出 website/build/);本地预览 npm run serve。文档在 website/docs/ 添加带 YAML frontmatter 的 Markdown 文件,支持 sidebar_position、sidebar_label、title、description、slug;文件夹用 category.json 控制标签、位置与折叠;侧边栏可自动生成或编辑 sidebars.js。博客为 blog/ 下日期前缀 Markdown,含 slug、title、authors、tags 与 <!-- truncate -->。图片:文档截图存 docs/screenshots/,用 ../../docs/screenshots/ 引用;站点通用图片存 website/static/img/,用 /img/ 引用。

风格与限制:禁止使用 emoji,改用 Lucide 图标(如 icon-terminal、icon-check);终端风格、等宽字体、深色背景与 Monokai 强调色。构建配置 onBrokenLinks: 'throw',本地可临时改 'warn';样式不更新可 npm run clear && npm start;GitHub Pages 404 需检查 baseUrl 与仓库名一致。合并到 main 后由 GitHub Actions 自动部署。

适用场景:为 Sidecar 编写插件文档、指南、博客与站点配置。具体收费、价格与平台信息暂未提供。