From 7a580ebe7d07b74328a3a1350ae9710997dddb24 Mon Sep 17 00:00:00 2001 From: ootomonaiso Date: Fri, 23 May 2025 21:19:46 +0900 Subject: [PATCH 1/3] =?UTF-8?q?feat:=20GitHub=20Copilot=E3=81=AE=E6=8C=87?= =?UTF-8?q?=E7=A4=BA=E3=82=92=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - GitHub Copilotに関するプロジェクトの概要、コーディング規約、補完方針を含む新しいドキュメントを作成しました。 - docusaurus.config.jsのカテゴリ追加方法、themeConfigのitems登録方法、footerのlinks登録方法についての具体的な指示を記載しました。 --- .github/copilot-instructions.md | 47 +++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 .github/copilot-instructions.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000..bb07307 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,47 @@ +# GitHub Copilot Instructions + +## Project Overview +このリポジトリは、Docusaurusを使用して構築されたドキュメントサイトです。このドキュメントでは、プロジェクトのセットアップ、開発、デプロイメントに関する手順を説明します。 + +## Coding Conventions +- 使用言語: TypeScript, markdown +- フレームワーク: React18.0によって記述されたDocusaurus3.0.0 +- buildツール: Node.js v20.11.0 +- GitHubActionsでビルドしてGitHubPagesにデプロイ + +## Copilot Behaviors +Copilot は以下の方針に従って補完してください： + +### docusaurus.config.jsの補完 +#### 新しくカテゴリを作成した場合、``docusaurus.config.js``にカテゴリを追加してください。 +- pluginsの配列に以下の形式でカテゴリの登録を行います + ```JavaScript + [ + '@docusaurus/plugin-content-docs', + { + id: '新規作成したフォルダ名', + path: '新規作成したフォルダ名', + routeBasePath: '新規作成したフォルダ名', + sidebarPath: require.resolve('./sidebars.js'), + editUrl: 'https://github.com/ootomonaiso/ootomonaiso_strage', + }, + ], + ``` + +- themeConfigのitems配下に以下の形式でカテゴリの登録を行います + ```JavaScript + { + to: '/新規作成したフォルダ名/intro', + position: 'left', + label: 'ここはユーザー決める', + }, + ``` + +- footerのlinks配下に以下の形式でカテゴリの登録を行います + ```JavaScript + { + label: '業務用ITソフトウェア', + to: '/IT_gyoumu/intro', + }, + ``` + From 2db3e9ad7e4dc3ceff2e4c6dcb457046849b14cf Mon Sep 17 00:00:00 2001 From: ootomonaiso Date: Fri, 23 May 2025 21:21:08 +0900 Subject: [PATCH 2/3] =?UTF-8?q?fix:=20docusaurus.config.js=E3=82=92docusau?= =?UTF-8?q?rus.config.ts=E3=81=AB=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Copilotの補完に関する指示を更新し、ファイル名を正しい拡張子に変更しました。 --- .github/copilot-instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index bb07307..c6ec002 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -12,7 +12,7 @@ ## Copilot Behaviors Copilot は以下の方針に従って補完してください： -### docusaurus.config.jsの補完 +### docusaurus.config.tsの補完 #### 新しくカテゴリを作成した場合、``docusaurus.config.js``にカテゴリを追加してください。 - pluginsの配列に以下の形式でカテゴリの登録を行います ```JavaScript From 652b54ab78e5f1d175e686f7021b8036cc5378cd Mon Sep 17 00:00:00 2001 From: ootomonaiso Date: Fri, 23 May 2025 21:26:06 +0900 Subject: [PATCH 3/3] =?UTF-8?q?fix:=20Copilot=E3=81=AE=E6=8C=87=E7=A4=BA?= =?UTF-8?q?=E3=82=92=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Docusaurusのフレームワーク表記を修正 - docusaurus.config.jsをdocusaurus.config.tsに変更 - コードブロックの言語をJavaScriptからTypeScriptに変更 - editUrlを正しいリポジトリのURLに更新 --- .github/copilot-instructions.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index c6ec002..e25b4d1 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -5,7 +5,7 @@ ## Coding Conventions - 使用言語: TypeScript, markdown -- フレームワーク: React18.0によって記述されたDocusaurus3.0.0 +- フレームワーク: Docusaurus 3.0.0 (React 18.0 上に構築) - buildツール: Node.js v20.11.0 - GitHubActionsでビルドしてGitHubPagesにデプロイ @@ -13,9 +13,9 @@ Copilot は以下の方針に従って補完してください： ### docusaurus.config.tsの補完 -#### 新しくカテゴリを作成した場合、``docusaurus.config.js``にカテゴリを追加してください。 +#### 新しくカテゴリを作成した場合、``docusaurus.config.ts``にカテゴリを追加してください。 - pluginsの配列に以下の形式でカテゴリの登録を行います - ```JavaScript + ```TypeScript [ '@docusaurus/plugin-content-docs', { @@ -23,13 +23,13 @@ Copilot は以下の方針に従って補完してください： path: '新規作成したフォルダ名', routeBasePath: '新規作成したフォルダ名', sidebarPath: require.resolve('./sidebars.js'), - editUrl: 'https://github.com/ootomonaiso/ootomonaiso_strage', + editUrl: 'https://github.com/ASK-STEM-official/stemask-docs/tree/main/', }, ], ``` - themeConfigのitems配下に以下の形式でカテゴリの登録を行います - ```JavaScript + ```TypeScript { to: '/新規作成したフォルダ名/intro', position: 'left', @@ -38,7 +38,7 @@ Copilot は以下の方針に従って補完してください： ``` - footerのlinks配下に以下の形式でカテゴリの登録を行います - ```JavaScript + ```TypeScript { label: '業務用ITソフトウェア', to: '/IT_gyoumu/intro',