initial

articles/index.md

@@ -0,0 +1,200 @@
+# Re:Earth Marketplace マニュアル
+
+ユーザー…プラグインを Marketplace からインストールして利用する人
+
+開発者…プラグインを自身で開発し、Marketplace へ公開する人
+
+# ユーザー向けマニュアル
+
+## 1. ログイン
+
+[https://marketplace.reearth.io](https://marketplace.reearth.io) へアクセスします。
+
+![Untitled](../images/Untitled.png)
+<br />
+<br />
+
+画面右上のログインボタンからログインします。
+
+![Untitled](../images/Untitled%201.png)
+<br />
+<br />
+
+ログインが成功すると再びトップ画面に戻ります。
+
+![Untitled](../images/Untitled%202.png)
+<br />
+<br />
+
+## 2. プラグインの検索
+
+トップ画面ではキーワードで検索ができ、お気に入りに登録しているプラグインがあればお気に入りにしているプラグインのみの表示に絞り込むこともできます。
+
+![Untitled](../images/Untitled%203.png)
+<br />
+<br />
+
+一覧からプラグインを選択すると、プラグインの詳細画面が表示されます。
+
+プラグイン詳細画面ではプラグインの Readme、スクリーンショット、開発者、バージョンの情報などが閲覧できます。
+
+![Untitled](../images/Untitled%204.png)
+<br />
+<br />
+
+ハートマークをクリックすることでプラグインをお気に入りに追加することが可能です。
+
+![Untitled](../images/Untitled%205.png)
+<br />
+<br />
+
+## 3. プラグインのインストール
+
+「プロジェクトに追加」をクリックするとログインしているアカウントの Re :Earth のワークスペースとそれに紐づくプロジェクトの一覧が表示されるので、インストールしたいプロジェクトを選択し、「選択」のボタンをクリックします。
+
+![Untitled](../images/Untitled%206.png)
+<br />
+<br />
+
+「選択」ボタンをクリックすると選択した Re :Earth のプロジェクトページへ飛び、こちらの画面が表示されます。こちらの画面でインストールボタンを再びクリックします。
+
+![Untitled](../images/Untitled%207.png)
+<br />
+<br />
+
+プラグインのインストールが成功すると「インストール」と書かれたボタンが「既にインストールされています」という表示に変わります。
+
+![Untitled](../images/Untitled%208.png)
+<br />
+<br />
+
+## アンインストール
+
+プロジェクト内にインストール済みのプラグインは Public Installed のタブをクリックすると一覧で確認することができます。
+また、アンインストールしたい場合には「アンインストール」ボタンを押すことでアンインストールが可能です。
+
+![Untitled](../images/Untitled%209.png)
+<br />
+<br />
+
+## プラグインを通報
+
+利用規約に反し、適切でないプラグインを発見した場合にはプラグインの詳細画面から「このプラグインを通報」ボタンをクリックすることで、運営にプラグインを通報することができます。
+
+![Untitled](../images/Untitled%2010.png)
+<br />
+<br />
+
+## ログアウト
+
+ログアウトは画面右上のユーザー名をクリックすることでログアウトボタンが押せるようになります。
+このボタンを押すとログアウトが完了します。
+
+![Untitled](../images/Untitled%2011.png)
+<br />
+<br />
+
+## 言語変更
+
+画面右上の言語メニューをクリックすることで日本語と英語の切り替えが可能です。
+自動はブラウザの言語設定によって言語が変わります。
+
+![Untitled](../images/Untitled%2012.png)
+<br />
+<br />
+
+# 開発者向けマニュアル
+
+こちらはプラグインを開発し Re :Earth Marketplace へアップロードする方向けのマニュアルです。
+
+## 1. プラグインのアップロード
+
+画面右上のアイコンをクリックし、アップロード画面へ遷移します。
+
+![Untitled](../images/Untitled%2013.png)
+<br />
+<br />
+
+アップロード画面では自分の PC からプラグインファイルを直接アップロードできる「PC からアップロード」というモードと GitHub のパブリックレポジトリにアップロードされているプラグインを URL からインポートさせる「GitHub レポジトリ」モードがあります。
+
+![Untitled](../images/Untitled%2014.png)
+<br />
+<br />
+
+### 1-1. PC からアップロード
+
+作成したプラグインを zip 圧縮し、このエリアからアップロードします
+
+![Untitled](../images/Untitled%2015.png)
+<br />
+<br />
+
+プラグインのファイル構造についてはこちらのレポジトリを参考にしてください。
+
+[https://github.com/reearth/plugin-example](https://github.com/reearth/plugin-example)
+
+アップロードが成功すると「ファイルのアップロードが成功しました」と通知が表示されます。
+
+![Untitled](../images/Untitled%2016.png)
+<br />
+<br />
+
+### 1-2. GitHub レポジトリからアップロード
+
+GitHub レポジトリタブをクリックし、表示されるフォームに自身のプラグインの GitHub の公開レポジトリの URL を入力してください。
+
+![Untitled](../images/Untitled%2017.png)
+<br />
+<br />
+
+アップロードが成功すると「詳細設定」のボタンがクリックできるようになるので、そちらをクリックします。
+
+![Untitled](../images/Untitled%2018.png)
+<br />
+<br />
+
+詳細設定ではアップロードされたファイルのプラグイン名やバージョンを確認でき、サムネイルとして表示する画像を 5 枚までアップロードが可能です。
+
+![Untitled](../images/Untitled%2019.png)
+<br />
+<br />
+
+## 2. プラグインの保存と公開
+
+プラグインの詳細設定が完了すると、「一時保存」と「保存と公開」ボタンがクリックできるようになります。
+
+「一時保存」はアップロードしたプラグインを公開せずに、保存しておくためのものです。アップロードと公開時期をずらしたい時に便利です。
+
+「保存と公開」はアップロードしたプラグインを即座に公開したい場合に便利です。
+
+![Untitled](../images/Untitled%2020.png)
+<br />
+<br />
+
+## 3. プラグインの公開/非公開化
+
+公開設定に関しては画面右上のユーザー ID をクリックし出てくる「マイプラグイン」のボタンを押すことでアップロードしたプラグインの一覧を確認することができます。
+
+![Untitled](../images/Untitled%2021.png)
+<br />
+<br />
+
+マイプラグイン画面では自分がアップロードしたプラグインの情報や公開・非公開の設定、アップデートなどが可能です。
+
+![Untitled](../images/Untitled%2022.png)
+<br />
+<br />
+
+## 4. プラグインのアップデート
+
+マイプラグインの画面からアップデートしたいプラグインのプラグイン更新アイコンをクリックします。
+
+![Untitled](../images/Untitled%2023.png)
+<br />
+<br />
+
+すると、プラグインをアップロードする画面に遷移するので、こちらで新たなバージョンのプラグインをアップロードすることでアップデートが完了します。
+
+![Untitled](../images/Untitled%2024.png)
+<br />
+<br />

articles/toc.yml

@@ -0,0 +1,2 @@
+- name: Re:Earth Marketplace マニュアル
+  href: index.md

docfx.json

@@ -0,0 +1,43 @@
+{
+  "metadata": [
+
+  ],
+  "build": {
+    "globalMetadata": {
+      "_appTitle": "Re:Earth Marketplace マニュアル",
+      "_appFooter": "Re:Earth Marketplace マニュアル",
+      "_enableSearch": true
+  },
+    "content": [
+      {
+        "files": [
+          "toc.yml",
+          "index.md"
+        ]
+      },
+      {
+        "src": "articles",
+        "files": [
+          "toc.yml",
+          "*.md"
+        ],
+        "dest": "docs"
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+
+    "xref": [
+      "https://normanderwan.github.io/UnityXrefMaps/xrefmap.yml"
+    ],
+    "xrefService": [
+      "https://xref.docs.microsoft.com/query?uid={uid}"
+    ],
+    "dest": "docs"
+  }
+}