diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 0000000..e25b4d1 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,47 @@ +# GitHub Copilot Instructions + +## Project Overview +このリポジトリは、Docusaurusを使用して構築されたドキュメントサイトです。このドキュメントでは、プロジェクトのセットアップ、開発、デプロイメントに関する手順を説明します。 + +## Coding Conventions +- 使用言語: TypeScript, markdown +- フレームワーク: Docusaurus 3.0.0 (React 18.0 上に構築) +- buildツール: Node.js v20.11.0 +- GitHubActionsでビルドしてGitHubPagesにデプロイ + +## Copilot Behaviors +Copilot は以下の方針に従って補完してください: + +### docusaurus.config.tsの補完 +#### 新しくカテゴリを作成した場合、``docusaurus.config.ts``にカテゴリを追加してください。 +- pluginsの配列に以下の形式でカテゴリの登録を行います + ```TypeScript + [ + '@docusaurus/plugin-content-docs', + { + id: '新規作成したフォルダ名', + path: '新規作成したフォルダ名', + routeBasePath: '新規作成したフォルダ名', + sidebarPath: require.resolve('./sidebars.js'), + editUrl: 'https://github.com/ASK-STEM-official/stemask-docs/tree/main/', + }, + ], + ``` + +- themeConfigのitems配下に以下の形式でカテゴリの登録を行います + ```TypeScript + { + to: '/新規作成したフォルダ名/intro', + position: 'left', + label: 'ここはユーザー決める', + }, + ``` + +- footerのlinks配下に以下の形式でカテゴリの登録を行います + ```TypeScript + { + label: '業務用ITソフトウェア', + to: '/IT_gyoumu/intro', + }, + ``` +