Page is under construction.
Check the github issues for ways to contribute! Or provide your feedback in this quick form
Check the github issues for ways to contribute! Or provide your feedback in this quick form
Snippets Folder Inventory
This page provides a comprehensive inventory of all files and folders in the/snippets directory. The snippets folder is the central location for all custom components, data, scripts, and assets used in the Livepeer documentation.
Overview
The snippets folder contains:- Components - Custom React/JSX components organized by purpose
- Data - Reusable data files (code strings, variables, API specs)
- Pages - Modular MDX content imported into main documentation pages
- Scripts - Automation and generation scripts
- Automations - Data fetching and processing automation files
- Assets - Images, logos, media files, and static assets
- Styles - Theme and styling definitions
- SnippetsWiki - Internal documentation about the snippets system
Directory Structure
Components (/snippets/components/)
Custom React/JSX components organized by purpose:
Primitives (/snippets/components/primitives/)
buttons.jsx- Button components (BasicBtn, DownloadButton)divider.jsx- CustomDivider componenticons.jsx- Livepeer brand icons (LivepeerIcon, LivepeerSVG, etc.)links.jsx- Link and navigation components (GotoLink, GotoCard, CustomCallout, etc.)text.jsx- Text components (Subtitle, CopyText, etc.)
Layout (/snippets/components/layout/)
cards.jsx- Card layout components (PostCard, BlogCard, ScrollBox)lists.jsx- List components (BasicList, IconList, StepList, etc.)ListSteps.jsx- ListSteps component for rendering lists as stepssteps.jsx- Styled step components (StyledSteps, StyledStep)table.jsx- DynamicTable componentquadGrid.jsx- QuadGrid layout componenttext.jsx- Text layout components (AccordionLayout)
Display (/snippets/components/display/)
video.jsx- Video components (YouTubeVideo, CardVideo, LinkedInEmbed)image.jsx- Image components (Image, LinkImage)embed.jsx- Embed components (MarkdownEmbed, EmbedMarkdown)zoomable-diagram.jsx- ScrollableDiagram componentquote.jsx- Quote components (Quote, FrameQuote)frameMode.jsx- Frame mode heading components (PageHeader, H1-H6, P, Divider)showcaseCards.jsx- ShowcaseCards componentsocialLinks.jsx- SocialLinks componentCardCarousel.jsx- CardCarousel component
Content (/snippets/components/content/)
code.jsx- Code display components (CustomCodeBlock, CodeComponent, ComplexCodeBlock)external-content.jsx- ExternalContent component for loading external docsrelease.jsx- LatestVersion componentresponseField.jsx- API response field components (ResponseFieldGroup, ValueResponseField, etc.)
Integrations (/snippets/components/integrations/)
coingecko.jsx- CoinGeckoExchanges component
Domain (/snippets/components/domain/)
Domain-specific components organized by documentation section:
04_GATEWAYS/- Gateway-specific componentscallouts.jsx- Gateway warning/note calloutsquickstartTabs.jsx- Gateway quickstart UI components
SHARED/- Shared components across domainsHeroGif.jsx- Starfield animation componentPortals.jsx- Portal page layout componentspreviewCallouts.jsx- Preview/coming soon callouts
Data (/snippets/data/)
Reusable data files for code strings, variables, and references:
gateways/- Gateway-related data filescode.jsx- Docker and installation code stringsflags.jsx- Configuration flagsquickstart.jsx- Quickstart datalinux/- Linux-specific code data
references/- Reference datachainlist.jsx- Chainlist RPC data
variables/- Variable definitionshome.mdx- Home page variablesvariables.mdx- Global variables
API/- API-related dataREADME.md- API documentation generation guideopenapi.yaml- OpenAPI specifications
Pages (/snippets/pages/)
Modular MDX content imported into main documentation pages:
00_HOME/- Home page content01_ABOUT/- About section content04_GATEWAYS/- Gateway documentation contentrun/quickstart/- Quickstart views by OS and mode
05_GPUS/- GPU-related content08_SHARED/- Shared page content
Scripts (/snippets/scripts/)
Automation and generation scripts:
update-component-library.sh- Auto-updates component library listinggenerate-api-docs.sh- Generates API documentation from OpenAPI specsgenerate-seo.js- Generates SEO metadatafetch-external-docs.sh- Fetches external documentationfetch-openapi-specs.sh- Fetches OpenAPI specificationsfetch-lpt-exchanges.sh- Fetches LPT exchange datagenerate-data/- Data generation scriptsscripts/terminology-search.js- Discovers glossary terminologyscripts/generate-glossary.js- Generates glossary terms
paths.config.json- Configuration for script paths
Automations (/snippets/automations/)
Data fetching and processing automation files:
blog/- Blog data (Ghost blog integration)discord/- Discord announcements dataforum/- Forum data integrationglobals/- Global automation data (versions, etc.)luma/- Luma calendar integrationyoutube/- YouTube data integrationshowcase/- Showcase project datascripts/- n8n workflow scripts (JSON)
Assets (/snippets/assets/)
Static assets including images, logos, and media:
logos/- Livepeer logos and brand assetsdomain/- Domain-specific assets organized by sectionmedia/- Media files (gifs, images, videos)site/- Site-wide assets (favicon, images)data/- Data files (HTML exports, etc.)
Styles (/snippets/styles/)
themeStyles.jsx- Theme styling definitions (deprecated - use CSS Custom Properties instyle.cssinstead)
SnippetsWiki (/snippets/snippetsWiki/)
Internal documentation about the snippets system:
index.mdx- Overview of snippets foldermintlify-behaviour.mdx- Mintlify-specific patterns and gotchastheme-colors.mdx- Theme color system documentationcomponentLibrary/- Component library documentationindex.mdx- Auto-generated component structure (updated by script)examples/- Component examples
File Count Summary
- Components: ~50+ JSX/TSX files across 6 categories
- Data Files: ~20+ JSX/MDX files
- Page Modules: ~20+ MDX files
- Scripts: ~10+ shell/JS scripts
- Automations: ~15+ JSX/JSON files
- Assets: 100+ image/media files
- Total: 200+ files in snippets folder
Usage Patterns
Importing Components
Importing Data
Importing Page Modules
Automation
The component library listing is automated: Script:snippets/scripts/update-component-library.sh
Output: snippets/snippetsWiki/componentLibrary/index.mdx
Usage:
snippets/components/.
Related Resources
- Component Library - Detailed component reference
- Style Guide - Styling and Mintlify gotchas
- Snippets Wiki - Internal snippets documentation
- Mintlify Behavior Guide - Mintlify-specific patterns