Discourseをプラグイン、テーマ、テーマコンポーネントで拡張し、コアコードを操作し、Discourse APIを使用する方法に関するドキュメント。
概要
- 概要: Discourse開発の紹介
開発環境
- Dev Container: Dev Containerを用いたDiscourseの開発
- GitHub Codespaces: GitHub CodespacesでのDiscourse開発
- Dockerセットアップ: Dockerを使用して開発用にDiscourseをインストールする
- macOSセットアップ: macOSに開発用にDiscourseをインストールする
- Ubuntu/Debianセットアップ: UbuntuまたはDebianに開発用にDiscourseをインストールする
- Windowsセットアップ: Windowsに開発用にDiscourseをインストールする
- 非Dockerプラグイン: 非Docker開発環境にプラグインをインストールする
- ローカルセットアップ: ローカルDiscourse開発環境をセットアップしますか?
- マルチサイトセットアップ: マルチサイト開発環境をセットアップする
- Fedoraセットアップ: Fedora Linuxで開発用にDiscourseをセットアップする
コードと内部構造
- Emberコンポーネント: DiscourseにEmberコンポーネントを追加する
- UIキット: Discourseの共有コンポーネント、ヘルパー、モディファイヤーのUIキット
- Lintとフォーマット: コミット前にコードを自動的にLintしフォーマットする
- アクセプテスト: DiscourseのEmberコードに対するアクセプテストを記述する
- テストスイートの実行: Discourseコア、プラグイン、テーマのQUnitテストスイートを実行する方法
- バージョン互換性: 古いDiscourseインストール用にプラグインとテーマのバージョンを固定する(d-compatブランチ)
- Emberオブジェクト所有権: Emberオブジェクトの所有権(getOwner、サービスインジェクションなど)
- JSパフォーマンス: Googleの「tachometer」を使用してDiscourseのJSパフォーマンス変更を測定する
- GitHub ActionsによるCI: GitHub Actionsを使用して継続的インテグレーションを設定する
- Markdown拡張: Markdown拡張の開発者ガイド
- モーダルの移行: レガシーコントローラーから新しいDModalコンポーネントAPIへのモーダル移行
- DModal API: DModal APIを使用してDiscourseにモーダルウィンドウ(ポップアップ/ダイアログ)を描画する
- JS API: JS APIの使用
- プラグインアウトレットコネクタ: テーマまたはプラグインからプラグインアウトレットコネクタを使用する
- modifyClass: modifyClassを使用してコアの動作を変更する
- ルートの作成: Discourseでのルート作成とデータの表示
- 認証メソッド: Discourseに新しい「管理型」認証メソッドを追加する
- ActiveRecordモデルの誤ったシリアライズ: ActiveRecordモデルの誤ったシリアライズを防ぐ
- テンプレートのオーバーライド: (推奨されません)テーマまたはプラグインからDiscourseテンプレートをオーバーライドする
- サービスオブジェクト: Discourseでサービスオブジェクトを使用する
- システムスペック: Discourseユーザーインターフェースのエンドツーエンドシステムスペックを記述する
- FormKit: フォームを描画するためのDiscourseツールキット。
- AppEventsトリガー: AppEventsトリガーリファレンス
- トランスフォーマー: トランスフォーマーを使用してクライアント側の値と動作をカスタマイズする
- トピックリストのカスタマイズ: トピックリストをカスタマイズする
- CSSガイドライン: BEMを使用したCSSクラスのガイドライン
- JS型ヒントと検証: JavaScriptの型ヒントと検証(typescript)
- デバイス向け設計: 異なるデバイス向け(タッチ&ホバー)の設計
- レスポンシブ幅向け設計: レスポンシブ幅向け(ブレークポイント、ビューポート&コンテナ)の設計
- ジェスチャプリミティブ: ドラッグ、リサイズ、ジェスチャプリミティブ
- バンドル分割: プラグイン用バンドル分割
- プライベートモジュール: プライベートモジュールと
-internals規約 - コンポーネントテスト: Discourse用のコンポーネントテストを記述する
プラグイン
- 基本プラグイン: Discourseプラグインの開発 - Part 1 - 基本的なプラグインの作成
- プラグインアウトレット: Discourseプラグインの開発 - Part 2 - プラグインアウトレットへの接続
- サイト設定: Discourseプラグインの開発 - Part 3 - カスタムサイト設定の追加
- Gitセットアップ: Discourseプラグインの開発 - Part 4 - Gitのセットアップ
- 管理者インターフェース: Discourseプラグインの開発 - Part 5 - 管理者インターフェースの追加
- アクセプテスト: Discourseプラグインの開発 - Part 6 - アクセプテストの追加
- プラグインの公開: Discourseプラグインの開発 - Part 7 - プラグインの公開
- 新しいロケール: プラグインから新しいロケールを追加する
- チャット統合: discourse-chat-integrationに新しいプロバイダーを追加する
- markdown-it拡張: markdown-it拡張をDiscourseプラグインとして再パッケージ化する
- Railsオートローディング: Railsオートローディング用にプラグインを構造化する
テーマとコンポーネント
- テーマの開発: Discourseテーマとテーマコンポーネントの開発
- クイックリファレンス: テーマ開発者クイックリファレンスガイド
- デザイナー向けガイド: Discourseのテーマを使い始めるためのデザイナー向けガイド
- Theme Creator: Theme CreatorとTheme CLIを開始する
- Theme CLI: テーマの構築を支援するDiscourse Theme CLIコンソールアプリをインストールする
- テーマの構造: テーマとテーマコンポーネントの構造
- 複数のJSファイル: テーマJavaScriptを複数のファイルに分割する
- 複数のSCSSファイル: テーマSCSSを複数のファイルに分割する
- テーマ設定: Discourseテーマに設定を追加する
- テーマ設定のオブジェクト: テーマ設定用のオブジェクト型
- 設定の移行: Discourseテーマ設定を移行する
- テーマメタデータ: テーマにメタデータとスクリーンショットを追加する
- コア変数: テーマでDiscourseコア変数を使用する
- ローカライズ可能な文字列: テーマとテーマコンポーネントにローカライズ可能な文字列を追加する
- E2Eテスト: テーマとテーマコンポーネントのエンドツーエンドシステムテスト
- メンテナンスの最小化: テーマカスタマイズのメンテナンスを最小限にする
- フォントサイズ: テーマのフォントサイズを変更する
- アセットの組み込み: テーマとコンポーネントにアセット(画像やフォントなど)を 포함する
- カスタムアイコン: テーマでDiscourseのデフォルトSVGアイコンをカスタムアイコンに置き換える
- ダークモード: テーマとプラグインを更新して自動ダークモードをサポートする
- テーマモディファイヤー: テーマモディファイヤー: 简要介绍
- 疑似要素: CSS疑似要素を使用してサイトのどこにでもテキストや画像を挿入する
- フォントコンポーネント: フォントテーマコンポーネントを作成して共有する
- Highlight.JS言語: テーマコンポーネントを介してHighlight.JS用の新しい言語をインストールする
- ホームページコンテンツ: ホームページにのみ表示されるカスタムコンテンツを追加する
- メッセージフォーマット: ローカライズのためのMessage Formatサポート
- グローバルアイコン変更: アイコンをグローバルに変更する
- 代替アイコン: 代替アイコン
- ウィキ投稿スタイル: ウィキ投稿のスタイルを変更する
- 配色 scheme: 配色 schemeを作成して共有する
- ナビゲーションメニュー: サイドバーや他のオプションをプレビューするために
navigation_menuクエリパラメータを使用する - 投稿コンテンツスタイル: 独自スタイルで投稿のコンテンツをカスタマイズする
- テーマスクリーンショット: Discourseテーマにプレビュースクリーンショットを追加する
- テーマ化可能なサイト設定: テーマでサイト設定を制御する
総合ガイド
- モバイルアプリのホワイトラベリング: Discourseモバイルアプリをホワイトラベリングすることを決定する前に考慮すべき事項
- カスタム自動化: カスタム自動化を作成する
- 公開データダンプ: Discourse公開データダンプ
- AI評価: Discourse AI評価を実行する
- API経由のAIボット: Discourse APIを介してAIボットを使用する
テーマ開発チュートリアル
- 1 - 概要: テーマ開発者チュートリアル: 1. 概要
- 2 - リモートテーマ: テーマ開発者チュートリアル: 2. リモートテーマの作成
- 3 - CSS: テーマ開発者チュートリアル: 3. テーマ内のCSS
- 4 - アウトレット: テーマ開発者チュートリアル: 4. アウトレットを使用してコンテンツを挿入および置き換える
- 5 - コンポーネント: テーマ開発者チュートリアル: 5. コンポーネントの構築と使用
- 6 - JS API: テーマ開発者チュートリアル: 6. JS APIの使用
- 7 - 結論: テーマ開発者チュートリアル: 7. まとめ