コンテンツにスキップ

資料の作成方法

フォルダ構成

このプロジェクトでは、src/content/docs/ 以下に Markdown (.md / .mdx) ファイルを追加していくことで、サイト上に新しいページを作成できます。

`docs` 内フォルダの役割

フォルダ名	対応する内容
app-tutorial	アプリ開発の意義、アプリ開発に関するツール紹介をします
contributors	コントリビュータ紹介をします
for-developer	資料作成者向けドキュメントです
optimization-introduction	最適化問題の基礎を解説します
optimization-formulation	最適化問題の定式化手法を解説します
optimization-application	最適化問題の応用事例を紹介します
qubo-solver	QUBOソルバーの紹介をします
quantum-annealing	量子アニーリングの紹介をします
python-uv	`uv` を使ったPythonの環境構築方法を解説します
streamlit-playground	`streamlit` 関連のチュートリアルを格納します。サイト上で実際に動作を確認できます。
（追加可能）	新しいテーマやカテゴリーを作りたい場合は、新しいフォルダを作成してください。

新しくページを追加する手順

Markdownファイルを作成する

例：how-to-solvequbo.md を optimization/ フォルダに作成します。
```
src/content/docs/optimization/how-to-solvequbo.md
```
新しいフォルダの作成が必要な場合は勝手に作成してOKです。
ファイルの先頭にタイトルを設定する

各ファイルの先頭に以下のようなフロントマターを書きます：
```
---
title: QUBO問題の解き方
---
```
title の内容がサイドバーで表示されるタイトルになります。
本文をマークダウンで記述する

通常の Markdown 記法で内容を書きます。 .mdx を使う場合は、React コンポーネントを埋め込むことも可能です。

使用例：Starlightドキュメント -カード-

完成ページ例

---
title: uvのインストール
---

:::note
Windows / macOS / Linux で動作します。
:::

---

## 0. 事前準備（共通）

- 安定したネットワーク
- Git（任意・推奨）
- VS Code などのエディタ（推奨）

---

## 1. uv のインストール

### macOS / Linux

インストールコマンド：

```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

### Windows (PowerShell)

PowerShell を **管理者として** 開きます。
インストールコマンド：

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

> `uv --version` の実行結果が表示されれば インストール完了です。
> 実行例：

```bash
% uv --version
uv 0.7.8 (0ddcc1905 2025-05-23)
```

インストール直後に上記コマンドの実行結果が何も表示されない場合、TerminalやVSCode, PowerShellの再起動を行えば表示されると思います。

編集が完了したら

各自の作業ブランチで編集した場合は、プルリクエストを作成して管理者にレビューを依頼してください。

お疲れさまでした！
この手順に従うことで、新しいドキュメントを簡単に追加・公開できます 🚀