Vue d'ensemble

Les contributions à la documentation sont les bienvenues ! Ce guide explique comment contribuer à la documentation de LibreChat en rédigeant et en formatant une nouvelle documentation. Le site web est construit avec Fumadocs et la documentation utilise le format .mdx.

Quand rédiger une documentation par rapport à un article de blog

Démarrage

• Forkez le dépôt de documentation de LibreChat : https://github.com/LibreChat-AI/librechat.ai

• Créez une branche sur votre fork, nommez-la correctement et liez-la au dépôt original.

git clone -b branch-name https://github.com/username/librechat.ai.git

Remplacez branch-name et username par vos informations

Création de nouveaux documents

Pour créer un nouveau document :

• Utilisez l'extension de fichier .mdx (voir la documentation MDX pour plus d'informations).
• Nommez les fichiers en utilisant des lettres minuscules et des traits de soulignement (par exemple, documentation_guidelines.mdx).
• Placez les nouveaux documents dans le dossier/sous-dossier approprié sous content/docs.
• Ajoutez le document au tableau pages dans le fichier meta.json du dossier où se trouve votre document. Si vous ne l'ajoutez pas, Fumadocs pourra toujours le découvrir, mais il n'apparaîtra pas dans l'ordre prévu dans la barre latérale.

Directives de formatage Markdown

• Utilisez des titres et des sous-titres avec #, ## et ###.
  • Utilisez # pour le titre du document (un seul titre principal est autorisé par document).
  • Utilisez ## pour les sections principales.
  • Utilisez ### pour les sous-sections au sein d'une section.
• Utilisez ** pour mettre le texte en gras et souligner les informations importantes (ne l'utilisez pas à la place d'un titre).
• Utilisez les chemins d'URL pour créer des liens vers d'autres documents (par exemple, /docs/documentation pointe vers le doc actuel).
• Vous pouvez utiliser HTML, TS et JS pour ajouter des fonctionnalités supplémentaires à un document.
• Assurez-vous que tout HTML possède des balises de fermeture (par exemple, <img src="" /> ou <a href="link"></a>).
• N'utilisez pas de commentaires HTML ; utilisez plutôt des commentaires Markdown uniquement si le texte est réellement masqué.

Ressources de documentation

Métadonnées du document

Ajoutez des métadonnées à l'en-tête de votre document en utilisant le format suivant :

Remarque : Le champ ogImage est facultatif et peut être entièrement omis. Il est utilisé pour spécifier l'image qui sera affichée lors du partage de votre document sur les plateformes de réseaux sociaux.

---
title: Document Title
description: This description will be used in social cards and search engine results.
ogImage: /images/docs/<category>/image.png (optional)
---

Assets

Dans la mesure du possible, téléversez les ressources (par exemple, les images) sur GitHub plutôt que de les stocker dans le dossier /public. Cela permet de garder votre dépôt organisé et facilite la gestion de vos ressources.

Images

Pour les captures d'écran qui doivent s'adapter au thème actif, utilisez le composant ThemeImage. Fournissez une source light et dark et il affichera la variante correspondant au thème du lecteur. Il prend également en charge le zoom au clic, comme toutes les autres images.

voyez l'exemple suivant en action ici : Guides de l'utilisateur

<ThemeImage
  light="https://github.com/danny-avila/LibreChat/assets/32828263/cf0f3231-287a-407f-bd4d-3d5bad94e893"
  dark="https://github.com/danny-avila/LibreChat/assets/32828263/a03ee02d-5099-4220-95b0-bfa2d3b00b4d"
  alt="LibreChat running on an iPad"
/>

Comment télécharger des images et des vidéos sur GitHub

Tester la documentation