SuperAPI AI 工具集

mapcn-docs

编程与开发

查看项目

更新于 10-16 00:01

技能介绍

用途:mapcn-docs 用于搭建带实时组件预览和可复制代码示例的文档站点,适合组件库、设计系统文档、API 参考页以及类似 shadcn/ui 的标签式预览/代码视图。不适用于简单静态文档、无需实时预览或非 Next.js App Router/React 项目。

主要能力:提供预览与代码双标签视图;用 Shiki 做语法高亮并支持明暗主题;所有代码示例可一键复制;响应式侧边栏导航(含移动端);滚动跟踪的目录(TOC);基于 shadcn/ui 的可访问组件。核心组件包括 DocsLayout、DocsSection、DocsHeader、DocsNote、DocsCode、DocsLink、DocsPropTable、ComponentPreview、CodeBlock。

使用方式:前置条件为 Next.js 13+ App Router(app/ 目录)、已配置 Tailwind CSS、已初始化 shadcn/ui。安装依赖:npm install shiki 与 npx shadcn@latest add sidebar table card tabs;若未初始化 shadcn/ui,先运行 npx shadcn@latest init。文档页按固定结构编写,示例组件放在 _components/examples/,并用固定高度容器(如 h-[400px])包裹以保证预览一致。导航在 docs-navigation.ts 中配置。代码高亮通过 lib/highlight.ts 的 highlightCode 调用 Shiki,示例源码通过 lib/get-example-source.ts 读取并转换导入路径(如 @/registry/ 转为 @/components/ui/)。新增页面需创建路由、示例组件、更新导航及相邻页面的上一页/下一页链接。

限制与注意:Shiki 的 highlightCode 只能在服务端组件中调用,客户端组件调用会报错;示例需固定高度;复制按钮依赖 HTTPS 或 localhost;暗色模式需在 Shiki 配置中设置 defaultColor: false 并使用 CSS [data-theme] 选择器。资料未提供收费、价格、平台或效果信息。