Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# GitHub Copilot Instructions

## Project Overview
このリポジトリは、Docusaurusを使用して構築されたドキュメントサイトです。このドキュメントでは、プロジェクトのセットアップ、開発、デプロイメントに関する手順を説明します。

## Coding Conventions
- 使用言語: TypeScript, markdown
Comment thread
saitogo555 marked this conversation as resolved.
- フレームワーク: 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',
},
```