Skip to content

README.ja.md

Latest commit

 

History

History
394 lines (262 loc) · 14.6 KB

README.ja.md

File metadata and controls

394 lines (262 loc) · 14.6 KB

🔥 OpenCodeDocs

VitePress License Cloudflare Languages

🎯 #1 AI エコシステムチュートリアルサイト · ソース駆動 · 100% 実行可能

AI ツールの更新が早すぎる？公式ドキュメントが追いつかない？ネット上のチュートリアルは古い？

私たちはオープンソースプロジェクトのソースコードを深く分析し、すべてのコード行が検証されています。 ✅ 手順通りに進めれば、一度で成功し、無駄な時間を過ごしません。

🚀 学習を始める · ⭐ このリポジトリを Star · 💬 ディスカッションに参加

言語

简体中文 · English · 日本語 · 한국어 · Español · Français · Deutsch · Português · Русский · 繁體中文

💡 このような状況に遭遇したことはありませんか？

  • ❌ 公式ドキュメントの更新が遅れていて、手順通りに進めてもうまくいかない？
  • ❌ ネット上のチュートリアルはコピペで、コードがまったく動かない？
  • ❌ エラーに遭遇し、検索しても解決策が見つからない？
  • ❌ スキルアップしたいが、ソースコードレベルの実践的なガイドが見つからない？

OpenCodeDocs はこれらの問題を解決します。

✨ なぜ OpenCodeDocs を選ぶべきか？

🎯 ソース検証、ハルシネーションなし

ネットからコピーしたものではなく、実際のソースコードから導き出されたコアロジック

私たちはオープンソースプロジェクトのソースコードを深く分析し、すべてのコード行が自動検証されていることを保証します。チュートリアルは特定の Git Commit バージョンを明記しており、コードがどのバージョンに基づいているかを明確に把握できます。

🚀 継続的更新、同期アップグレード

ツールが更新されれば、チュートリアルも自動的に更新

プロジェクトがリリースされると、私たちのチュートリアルも同期して更新されます。チュートリアルが古くなることを心配する必要はなく、常に最新の内容を学習できます。

💡 私たちのチュートリアルは急速に更新中で、より多くの高品質プロジェクトを掲載中です！

🌍 10 以上の言語、世界中でアクセス可能

中国語、英語、日本語、韓国語、スペイン語、フランス語、ドイツ語、ポルトガル語、ロシア語、繁体字中国語...

どこにいても、母語で AI ツールを学習できます。

✅ 100% 実行可能、ゼロの試行錯誤

手順通りに進めれば、一度で成功。推測や試行錯誤は不要

チュートリアルの各ステップは検証されており、インストールからデプロイまで、手順通りに進めれば必ず動きます。手間をかけず、落とし穴を回避し、無駄な時間を過ごしません。

👤 どのカテゴリに属していますか？

🌱 AI ツール初心者

インストールできない？設定できない？心配不要、徹底的なガイドがあります

  • 基礎ゼロでも始められる
  • 各ステップに詳細な説明
  • 一般的なエラーには解決策付き

💻 上級開発者

スキルアップしたい？ソースコードを深く掘り下げましょう

  • 複数アカウントのローテーションテクニック
  • Token を節約する秘訣
  • Agent 自動化の実戦
  • ソースコードレベルの深い分析

🏢 技術チーム

チーム協業で統一規範が必要？

  • 再利用可能なベストプラクティス
  • 完全なプロジェクト構造
  • 本番環境デプロイガイド

🚀 3 分でクイックスタート

ステップ 1：リポジトリをクローン

git clone https://github.com/vbgate/opencodedocs.git
cd opencodedocs/site

ステップ 2：依存関係をインストール

npm install

ステップ 3：開発サーバーを起動

npm run dev

http://localhost:5173 にアクセスして、AI ツールの学習の旅を始めましょう！🎉

💡 ヒント：opencodedocs.com に直接アクセスしてオンラインドキュメントを閲覧することもできます。

📂 プロジェクト構造

site/
├── docs/                      # ドキュメントルート
│   ├── zh/                    # 中国語チュートリアル 🇨🇳
│   ├── en/                    # 英語チュートリアル 🇺🇸
│   ├── ja/                    # 日本語チュートリアル 🇯🇵
│   ├── ko/                    # 韓国語チュートリアル 🇰🇷
│   ├── es/                    # スペイン語チュートリアル 🇪🇸
│   ├── fr/                    # フランス語チュートリアル 🇫🇷
│   ├── de/                    # ドイツ語チュートリアル 🇩🇪
│   ├── pt/                    # ポルトガル語チュートリアル 🇵🇹
│   ├── ru/                    # ロシア語チュートリアル 🇷🇺
│   ├── zh-tw/                 # 繁体字中国語チュートリアル 🇹🇼
│   ├── .vitepress/            # VitePress 設定
│   │   ├── config.mts         # メイン設定ファイル
│   │   ├── sidebar.config.ts  # サイドバー自動生成
│   │   └── theme/             # カスタムテーマコンポーネント
│   ├── about.md               # 私たちについて
│   └── terms.md               # 利用規約
├── scripts/                   # ツールスクリプト
│   ├── add-order-to-md.ts     # ソートフィールドを追加
│   ├── check-frontmatter.ts   # Frontmatter 検査
│   └── create-category-indexes.ts  # カテゴリインデックス作成
├── package.json               # プロジェクト設定
├── tailwind.config.js         # Tailwind CSS 設定
└── postcss.config.js          # PostCSS 設定

🛠️ 技術スタック

技术 バージョン 説明
VitePress 1.x 静的サイトジェネレーター · 超高速ビルド
Vue 3.4+ フロントエンドフレームワーク · Composition API
Tailwind CSS 4.x スタイルシステム · CSS-first 設定
TypeScript 5.9+ 型安全性 · コンパイル時チェック
Mermaid 11.x 図表サポート · フローチャート可視化
Cloudflare Pages グローバル CDN · 200 以上のエッジノード

📚 開発ガイド

➕ 新しいチュートリアルを追加

  1. ディレクトリ構造を作成

    docs/zh/[owner]/[repo]/
├── index.md          # プロジェクトホーム
├── start/            # クイックスタート
├── features/         # 機能紹介
└── faq/              # よくある質問

  2. Frontmatter を記述

    ---
title: "チュートリアルタイトル"              # 2-6 文字
order: 10                                   # ソート（10, 20, 30...）
sidebarTitle: "サイドバータイトル"           # オプション
description: "SEO 説明"                     # 検索エンジン最適化
---

  3. ビルドを検証

    npm run docs:build

🌍 多言語サポートを追加

docs/.vitepress/sidebar.config.ts でプロジェクトを追加：

const projects = [
  'owner/repo',  // プロジェクトを追加
]

次に、home-config.[lang].json ファイルを翻訳します。

🎨 カスタムテーマ

  • コンポーネントの場所：docs/.vitepress/theme/components/
  • スタイルファイル：docs/.vitepress/theme/custom.css
  • Tailwind v4：CSS-first 設定方式を使用

🚀 デプロイガイド

ローカルビルド

npm run docs:build

ビルド成果物は docs/.vitepress/dist/ ディレクトリに配置されます。

Cloudflare Pages にデプロイ

# 自動デプロイ
npm run deploy

ビルド結果をプレビュー

npm run docs:preview

⚡ パフォーマンス最適化

  • 画像最適化：WebP 形式を使用、200KB 以下に圧縮
  • コード分割：VitePress がルートに基づいて自動分割
  • CDN 加速：静的リソースは自動的に Cloudflare CDN にアップロード
  • プリレンダリング：コアページをプリレンダリング、ファーストビューの読み込み < 500ms

✅ 私たちのサイトはグローバル CDN にデプロイされており、超高速でアクセスできます！

🤝 コントリビューション

コミュニティからの貢献を歓迎します！チュートリアルの提出、バグ修正、新機能の追加など。

貢献フロー

  1. リポジトリを Fork

    # GitHub ページの Fork ボタンをクリック

  2. 機能ブランチを作成

    git checkout -b feature/amazing-feature

  3. 変更をコミット

    git commit -m 'Add amazing feature'

  4. ブランチにプッシュ

    git push origin feature/amazing-feature

  5. Pull Request を送信

  • GitHub ページの "Pull Request" ボタンをクリック
  • PR の説明を記入し、変更内容を説明

🌟 あなたの貢献は世界中の開発者が AI ツールをより良く使うのに役立ちます！

📥 チュートリアル申請を提出

プロジェクトに高品質なチュートリアルを掲載したい？わずか 3 ステップ！

📝 申請フロー

ステップ 1：Issue を送信

  1. GitHub Issues にアクセス
  2. "New Issue" をクリック
  3. 以下のテンプレートを使用：
**プロジェクト名**：[プロジェクト名]
**GitHub リポジトリ**：https://github.com/[owner]/[repo]
**プロジェクト概要**：[1-2 文でプロジェクトの用途を説明]
**ターゲットオーディエンス**：[初心者/中級者/エキスパート/全員]
**チュートリアル言語**：[中国語/英語/その他]
**備考**：[その他補足事項]

ステップ 2：チームによる審査

  • 1-3 営業日以内に申請を審査します
  • プロジェクトが掲載に適しているかを評価
  • プロジェクトのソースコード品質とアクティビティを確認

ステップ 3：チュートリアル公開

  • 審査合格後、チュートリアルを自動生成
  • 各ステップの実行可能性を検証
  • 公式サイトに公開、多言語対応

⏱️ 処理時間

  • 審査期間：1-3 営業日
  • チュートリアル生成：3-7 営業日
  • 公開時期：審査合格後すぐに公開

❓ よくある質問

Q: どのようなプロジェクトが掲載に適していますか？ A: オープンソースの AI ツール、開発ツール、ライブラリ、フレームワークなど。一定の技術的深さと使用価値が必要です。

Q: チュートリアルは無料ですか？ A: はい、私たちのチュートリアルは完全に無料で、継続的に更新・メンテナンスされます。

Q: チュートリアルの言語を指定できますか？ A: はい、10 の言語をサポートしています。Issue で必要な言語を指定してください。

🎯 今すぐ送信：Issue を作成 →

📄 ライセンス

サイトコード

MIT License

チュートリアルコンテンツ

CC-BY-NC-SA 4.0

帰属 - 非営利 - 同一条件許諾

✅ あなたは以下のことができます：

  • 📋 共有：自由に共有・改変
  • 🔧 変更：チュートリアルコンテンツに基づいて二次創作
  • 👥 貢献：改善を提出

❌ あなたは以下のことはできません：

  • 💰 商業利用：許可なく商用目的での使用は禁止

💡 チュートリアルを商用目的で使用したい場合は、ご連絡ください：vbgatecom@gmail.com

📞 お問い合わせ

ご質問やご提案がございましたら、いつでもお気軽にお問い合わせください！

🎉 OpenCodeDocs を選んでいただきありがとうございます！

最初のコード行から本番レベルのアプリケーションまで、各段階のチュートリアルを提供します。

⭐ このリポジトリを Star · 📥 チュートリアル申請 · 💬 ディスカッションに参加

Made with ❤️ by OpenCodeDocs Team