代码片段文件夹包含:
- 组件 - 按用途组织的自定义 React/JSX 组件
- 数据 - 可重用的数据文件(代码字符串、变量、API 规范)
- 页面 - 模块化 MDX 内容导入主文档页面
- 脚本 - 自动化和生成脚本
- 自动化 - 数据获取和处理自动化文件
- 资产 - 图像、徽标、媒体文件和静态资源
- 样式 - 主题和样式定义
- 片段Wiki - 关于片段系统的内部文档
目录结构
组件 (/snippets/components/)
按用途组织的自定义 React/JSX 组件:
基础组件 (/snippets/components/primitives/)
buttons.jsx - 按钮组件 (BasicBtn, DownloadButton)
divider.jsx - 自定义分割线组件 (CustomDivider)
icons.jsx - Livepeer 品牌图标 (LivepeerIcon, LivepeerSVG, 等等)
links.jsx - 链接和导航组件 (GotoLink, GotoCard, CustomCallout, 等等)
text.jsx - 文本组件 (Subtitle, CopyText, 等等)
布局 (/snippets/components/layout/)
cards.jsx - 卡片布局组件 (PostCard, BlogCard, ScrollBox)
lists.jsx - 列表组件 (BasicList, IconList, StepList, 等等)
ListSteps.jsx - 用于将列表渲染为步骤的 ListSteps 组件
steps.jsx - 样式化步骤组件 (StyledSteps, StyledStep)
table.jsx - 动态表格组件
quadGrid.jsx - QuadGrid 布局组件
text.jsx - 文本布局组件 (AccordionLayout)
显示 (/snippets/components/display/)
video.jsx - 视频组件 (YouTubeVideo, CardVideo, LinkedInEmbed)
image.jsx - 图像组件 (Image, LinkImage)
embed.jsx - 嵌入组件 (MarkdownEmbed, EmbedMarkdown)
zoomable-diagram.jsx - 可滚动图表组件 (ScrollableDiagram)
quote.jsx - 引用组件 (Quote, FrameQuote)
frameMode.jsx - 框架模式标题组件 (PageHeader, H1-H6, P, Divider)
showcaseCards.jsx - 展示卡片组件 (ShowcaseCards)
socialLinks.jsx - 社交链接组件 (SocialLinks)
CardCarousel.jsx - CardCarousel 组件
内容 (/snippets/components/content/)
code.jsx - 代码显示组件 (CustomCodeBlock, CodeComponent, ComplexCodeBlock)
external-content.jsx - ExternalContent 组件用于加载外部文档
release.jsx - LatestVersion 组件
responseField.jsx - API 响应字段组件 (ResponseFieldGroup, ValueResponseField 等)
集成 (/snippets/components/integrations/)
coingecko.jsx - CoinGeckoExchanges 组件
域名 (/snippets/components/domain/)
按文档部分组织的特定于领域的组件:
04_GATEWAYS/ - 与网关相关的组件
callouts.jsx - 网关警告/注意事项提示框
quickstartTabs.jsx - 网关快速入门UI组件
SHARED/ - 跨领域的共享组件
HeroGif.jsx - 星场动画组件
Portals.jsx - 门户页面布局组件
previewCallouts.jsx - 预览/即将推出提示
数据 (/snippets/data/)
可重用的数据文件,用于代码字符串、变量和引用:
gateways/ - 与网关相关的数据文件
code.jsx - Docker 和安装代码字符串
flags.jsx - 配置标志
quickstart.jsx - 快速入门数据
linux/ - Linux 专用代码数据
references/ - 参考数据
chainlist.jsx - Chainlist RPC 数据
variables/ - 变量定义
home.mdx - 首页变量
variables.mdx - 全局变量
API/ - 与API相关的数据
README.md - API文档生成指南
openapi.yaml - OpenAPI规范
页面 (/snippets/pages/)
模块化 MDX 内容导入到主文档页面:
00_HOME/ - 首页内容
01_ABOUT/ - 关于部分内容
04_GATEWAYS/ - 网关文档内容
run/quickstart/ - 按操作系统和模式查看快速入门
05_GPUS/ - 与 GPU 相关的内容
08_SHARED/ - 共享页面内容
自动化和生成脚本:
update-component-library.sh - 自动更新组件库列表
generate-api-docs.sh - 从 OpenAPI 规范生成 API 文档
generate-seo.js - 生成 SEO 元数据
fetch-external-docs.sh - 获取外部文档
fetch-openapi-specs.sh - 获取 OpenAPI 规范
fetch-lpt-exchanges.sh - 获取 LPT 交易所数据
generate-data/ - 数据生成脚本
scripts/terminology-search.js - 发现术语表术语
scripts/generate-glossary.js - 生成术语表术语
paths.config.json - 脚本路径的配置
自动化 (/snippets/automations/)
数据获取和处理自动化文件:
blog/ - 博客数据(Ghost 博客集成)
discord/ - Discord 公告数据
forum/ - 论坛数据集成
globals/ - 全局自动化数据(版本等)
luma/ - Luma 日历集成
youtube/ - YouTube 数据集成
showcase/ - 展示项目数据
scripts/ - n8n 工作流脚本 (JSON)
资产 (/snippets/assets/)
静态资源,包括图片、标志和媒体:
logos/ - Livepeer 标志和品牌素材
domain/ - 按章节组织的领域特定素材
media/ - 媒体文件(GIF、图片、视频)
site/ - 网站通用素材(favicon、图片)
data/ - 数据文件(HTML 导出等)
样式(/snippets/styles/)
themeStyles.jsx - 主题样式定义(已弃用 - 请使用 CSS 自定义属性在 style.css 中)
SnippetsWiki (/snippets/snippetsWiki/)
关于片段系统的内部文档:
index.mdx - 代码片段文件夹概述
mintlify-behaviour.mdx - 与Mintlify相关的模式和陷阱
theme-colors.mdx - 主题颜色系统文档
componentLibrary/ - 组件库文档
index.mdx - 自动生成的组件结构(由脚本更新)
examples/ - 组件示例
文件数量摘要
- 组件: ~50+ JSX/TSX 文件,分布在 6 个类别中
- 数据文件: ~20+ JSX/MDX 文件
- 页面模块: ~20+ MDX 文件
- 脚本: ~10+ shell/JS 脚本
- 自动化: ~15+ JSX/JSON 文件
- 资源: 100+ 图像/媒体文件
- 总计: 200+ 个文件在代码片段文件夹中
使用模式
导入组件
// Import from components
import { YouTubeVideo } from "/snippets/components/display/video.jsx";
import { GotoCard } from "/snippets/components/primitives/links.jsx";
import { CustomCodeBlock } from "/snippets/components/content/code.jsx";
导入数据
// Import data files
import { DOCKER_CODE } from "/snippets/data/gateways/code.jsx";
import { latestVersion } from "/snippets/automations/globals/globals.jsx";
导入页面模块
// Import MDX page modules
import DockerOffChainTab from "/snippets/pages/04_GATEWAYS/run/quickstart/views/docker/dockerOffChainTab.mdx";
自动化
组件库列表是自动化的:
脚本: tools/scripts/snippets/update-component-library.sh
输出: snippets/snippetsWiki/componentLibrary/index.mdx
用法:
./tools/scripts/snippets/update-component-library.sh
此脚本自动生成一个 Tree 结构,列出所有组件在 snippets/components/。
相关资源
Last modified on March 1, 2026