Passer au contenu principal

Aperçu

Le dossier des extraits contient :
  • Composants - Composants React/JSX personnalisés organisés par objectif
  • Données - Fichiers de données réutilisables (chaînes de code, variables, spécifications d’API)
  • Pages - Contenu MDX modulaire importé dans les pages principales de la documentation
  • Scripts - Scripts d’automatisation et de génération
  • Automations - Fichiers d’automatisation de récupération et de traitement des données
  • Actifs - Images, logos, fichiers multimédias et actifs statiques
  • Styles - Définitions de thème et de style
  • SnippetsWiki - Documentation interne sur le système de snippets

Structure du répertoire

Composants (/snippets/components/)

Composants React/JSX personnalisés organisés par objectif :

Primitifs (/snippets/components/primitives/)

  • buttons.jsx - Composants de bouton (BasicBtn, DownloadButton)
  • divider.jsx - Composant CustomDivider
  • icons.jsx - Livepeer icônes de marque (LivepeerIcon, LivepeerSVG, etc.)
  • links.jsx - Composants de lien et de navigation (GotoLink, GotoCard, CustomCallout, etc.)
  • text.jsx - Composants de texte (Subtitle, CopyText, etc.)

Disposition (/snippets/components/layout/)

  • cards.jsx - Composants de mise en page de carte (PostCard, BlogCard, ScrollBox)
  • lists.jsx - Composants de liste (BasicList, IconList, StepList, etc.)
  • ListSteps.jsx - Composant ListSteps pour afficher des listes sous forme d’étapes
  • steps.jsx - Composants d’étape stylisés (StyledSteps, StyledStep)
  • table.jsx - Composant DynamicTable
  • quadGrid.jsx - Composant de mise en page QuadGrid
  • text.jsx - Composants de mise en page de texte (AccordionLayout)

Afficher (/snippets/components/display/)

  • video.jsx - Composants vidéo (YouTubeVideo, CardVideo, LinkedInEmbed)
  • image.jsx - Composants image (Image, LinkImage)
  • embed.jsx - Composants intégrés (MarkdownEmbed, EmbedMarkdown)
  • zoomable-diagram.jsx - Composant ScrollableDiagram
  • quote.jsx - Composants de citation (Quote, FrameQuote)
  • frameMode.jsx - Composants d’en-tête en mode Frame (PageHeader, H1-H6, P, Divider)
  • showcaseCards.jsx - Composant ShowcaseCards
  • socialLinks.jsx - Composant SocialLinks
  • CardCarousel.jsx - Composant CardCarousel

Contenu (/snippets/components/content/)

  • code.jsx - Composants d’affichage de code (CustomCodeBlock, CodeComponent, ComplexCodeBlock)
  • external-content.jsx - Composant ExternalContent pour charger des documents externes
  • release.jsx - Composant LatestVersion
  • responseField.jsx - Composants de champs de réponse d’API (ResponseFieldGroup, ValueResponseField, etc.)

Intégrations (/snippets/components/integrations/)

  • coingecko.jsx - Composant CoinGeckoExchanges

Domaine (/snippets/components/domain/)

Composants spécifiques au domaine organisés par section de documentation :
  • 04_GATEWAYS/ - Composants spécifiques au portail
    • callouts.jsx - Avertissements/notes du portail
    • quickstartTabs.jsx - Composants d’interface utilisateur de démarrage rapide du portail
  • SHARED/ - Composants partagés entre les domaines
    • HeroGif.jsx - Composant d’animation de champ d’étoiles
    • Portals.jsx - Composants de mise en page de la page d’accueil
    • previewCallouts.jsx - Appels d’offre de prévisualisation/à venir

Données (/snippets/data/)

Fichiers de données réutilisables pour les chaînes de code, les variables et les références :
  • gateways/ - Fichiers de données liés au portail
    • code.jsx - Chaînes de code Docker et d’installation
    • flags.jsx - Drapeaux de configuration
    • quickstart.jsx - Données de démarrage rapide
    • linux/ - Données de code spécifiques à Linux
  • references/ - Données de référence
    • chainlist.jsx - Données RPC de la liste de chaînes
  • variables/ - Définitions des variables
    • home.mdx - Variables de la page d’accueil
    • variables.mdx - Variables globales
  • API/ - Données liées à l’API
    • README.md - Guide de génération de la documentation API
    • openapi.yaml - Spécifications OpenAPI

Pages (/snippets/pages/)

Contenu MDX modulaire importé dans les pages de documentation principales :
  • 00_HOME/ - Contenu de la page d’accueil
  • 01_ABOUT/ - Contenu de la section À propos
  • 04_GATEWAYS/ - Contenu de la documentation du Gateway
    • run/quickstart/ - Vue d’ensemble par système d’exploitation et mode
  • 05_GPUS/ - Contenu lié à la carte graphique
  • 08_SHARED/ - Contenu de page partagé

Scripts (/tools/scripts/snippets/)

Scripts d’automatisation et de génération :
  • update-component-library.sh - Met à jour automatiquement la liste des composants
  • generate-api-docs.sh - Génère la documentation de l’API à partir des spécifications OpenAPI
  • generate-seo.js - Génère les métadonnées SEO
  • fetch-external-docs.sh - Récupère la documentation externe
  • fetch-openapi-specs.sh - Récupère les spécifications OpenAPI
  • fetch-lpt-exchanges.sh - Récupère les données d’échange LPT
  • generate-data/ - Scripts de génération de données
    • scripts/terminology-search.js - Découverte des termes du glossaire
    • scripts/generate-glossary.js - Génération des termes du glossaire
  • paths.config.json - Configuration des chemins des scripts

Automatisations (/snippets/automations/)

Fichiers d’automatisation de la récupération et du traitement des données :
  • blog/ - Données du blog (intégration du blog Ghost)
  • discord/ - Données des annonces Discord
  • forum/ - Intégration des données du forum
  • globals/ - Données d’automatisation globale (versions, etc.)
  • luma/ - Intégration du calendrier Luma
  • youtube/ - Intégration des données YouTube
  • showcase/ - Données du projet de démonstration
  • scripts/ - Scripts de workflow n8n (JSON)

Actifs (/snippets/assets/)

Actifs statiques, y compris les images, les logos et les médias :
  • logos/ - Livepeer logos et actifs de marque
  • domain/ - Actifs spécifiques au domaine organisés par section
  • media/ - Fichiers multimédias (gifs, images, vidéos)
  • site/ - Actifs généraux du site (favicon, images)
  • data/ - Fichiers de données (exports HTML, etc.)

Styles (/snippets/styles/)

  • themeStyles.jsx - Définitions du thème (obsolète - utilisez les propriétés CSS personnalisées dans style.css à la place)

SnippetsWiki (/snippets/snippetsWiki/)

Documentation interne sur le système des extraits :
  • index.mdx - Aperçu du dossier des extraits
  • mintlify-behaviour.mdx - Modèles et pièges propres à Mintlify
  • theme-colors.mdx - Documentation du système de couleurs de thème
  • componentLibrary/ - Documentation de la bibliothèque de composants
    • index.mdx - Structure des composants générés automatiquement (mis à jour par le script)
    • examples/ - Exemples de composants

Résumé du nombre de fichiers

  • Composants: ~50+ fichiers JSX/TSX répartis en 6 catégories
  • Fichiers de données: ~20+ fichiers JSX/MDX
  • Modules de page: ~20+ fichiers MDX
  • Scripts: ~10+ scripts shell/JS
  • Automations: ~15+ fichiers JSX/JSON
  • Assets: 100+ fichiers/médias
  • Total: 200+ fichiers dans le dossier de snippets

Modèles d’utilisation

Importation de composants

// 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";

Importation de données

// Import data files
import { DOCKER_CODE } from "/snippets/data/gateways/code.jsx";
import { latestVersion } from "/snippets/automations/globals/globals.jsx";

Importation des modules de page

// Import MDX page modules
import DockerOffChainTab from "/snippets/pages/04_GATEWAYS/run/quickstart/views/docker/dockerOffChainTab.mdx";

Automatisation

La liste de la bibliothèque de composants est automatisée : Script : tools/scripts/snippets/update-component-library.sh Sortie : snippets/snippetsWiki/componentLibrary/index.mdx Utilisation :
./tools/scripts/snippets/update-component-library.sh
Ce script génère automatiquement une structure d’arbre listant tous les composants dans snippets/components/.

Ressources connexes

Last modified on March 1, 2026