LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

概要

ドキュメントへの貢献に関する包括的なガイド

ドキュメントへの貢献を歓迎します！このガイドでは、新しいドキュメントの執筆やフォーマットを行うことで、LibreChatのドキュメントに貢献する方法を説明します。このウェブサイトはFumadocsで構築されており、ドキュメントには.mdx形式が使用されています。

ドキュメントとブログ記事の書き分けについて

ブログ vs ドキュメント

ドキュメントが既存のドキュメントの拡張である場合、特定の状況に関連する場合、または外部でのメンテナンス（チームが積極的に使用していない機能など）が必要な場合は、ブログ記事として公開することを検討してください。

参照: ブログへの貢献

はじめに

  • LibreChat Documentationリポジトリをフォークしてください: https://github.com/LibreChat-AI/librechat.ai

  • フォーク上にブランチを作成し、適切な名前を付け、元のリポジトリにリンクしてください。

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

branch-name と username をご自身の詳細情報に置き換えてください。

新しいドキュメントの作成

新しいドキュメントを作成するには：

  • .mdx ファイル拡張子を使用してください（詳細は MDX documentation を参照してください）。
  • ファイル名は小文字とアンダースコアを使用して命名してください（例: documentation_guidelines.mdx）。
  • 新しいドキュメントは、content/docs 配下の適切なフォルダー/サブフォルダーに配置してください。
  • ドキュメントを配置したフォルダの meta.json ファイル内の pages 配列に、そのドキュメントを追加してください。追加しなくても Fumadocs はドキュメントを検出できますが、意図したサイドバーの順序では表示されません。

Markdown フォーマットガイドライン

#、##、および ### を使用して見出しと小見出しを作成します。

  • ドキュメントのタイトルには # を使用してください（ドキュメントごとにメインタイトルは1つだけ許可されています）。

  • ## をメインセクションに使用してください。

  • セクション内のサブセクションには ### を使用してください。
  • **を使用してテキストを太字にし、重要な情報を強調してください（見出しの代わりには使用しないでください）。
  • URLパスを使用して他のドキュメントにリンクします（例: /docs/documentation は現在の doc を指します）。
  • HTML、TS、およびJSを使用して、ドキュメントに機能を追加できます。
  • HTMLタグが閉じられていることを確認してください（例: <img src="" /> や <a href="link"></a>）。
  • HTMLコメントは使用しないでください。代わりに、Markdown comments を使用してください。ただし、テキストが実際に非表示である場合のみとしてください。

ドキュメントリソース

ドキュメントリソース

統合されたコンポーネントの例をいくつか参照してください：

詳細については、以下を参照してください：

ドキュメントのメタデータ

以下の形式を使用して、ドキュメントのヘッダーにメタデータを追加します：

注: ogImage フィールドは任意であり、完全に省略可能です。これは、ドキュメントをソーシャルメディアプラットフォームで共有する際に表示される画像を指定するために使用されます。

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

アセット

可能な限り、アセット（画像など）は /public フォルダに保存するのではなく、GitHubにアップロードしてください。これにより、リポジトリを整理し、アセットを管理しやすくなります。

画像

アクティブなテーマに適応させる必要があるスクリーンショットには、ThemeImage コンポーネントを使用してください。light および dark のソースを提供すると、読者のテーマに一致するバリアントがレンダリングされます。また、他のすべての画像と同様に、クリックしてズームする機能もサポートしています。

以下の例を実際に確認するには、こちらを参照してください: User Guides

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

GitHubで画像や動画をアップロードする方法

ドキュメントのテスト

送信する前に

PRを提出する前に慎重に確認してください

ブログ記事のPRを提出する前に、すべてが意図した通りに見え、機能することを確認するために必ずテストを行ってください。

以下を確認してください：

  • レイアウト、正確性、および完全性に関する新しいドキュメント
  • 目次 (ToC) におけるドキュメントの位置
  • ドキュメント内の画像とリンク

テストするには:

  1. pnpm install を実行して環境を準備します。
  2. pnpm dev で開発サーバーを起動します。
  3. pnpm build を実行し、続いて pnpm start を実行してビルドをテストします。

このガイドはいかがでしたか？

GitHub で編集