(migrate) docs

This commit is contained in:
kakkokari-gtyih 2023-07-18 01:42:23 +09:00
parent 1586934786
commit 11549f89ef
82 changed files with 310 additions and 2997 deletions

View File

@ -3,7 +3,25 @@
When you add files/text to the ja-JP directory (of misskey-dev/misskey-hub), it will automatically be applied to other language files.
Translations added in ja-JP file should contain the original Japanese strings.
# 移行作業
## 移行作業
- `.docs-legacy/`内にvuepress時代のファイルを格納
- `docs/`内にディレクトリ構造を作成中
- `docs/`内にディレクトリ構造を作成中
## 新規に作成したページ
- `/2.for-users/2.onboarding/index.md` 以外
- `/4.for-developers/play/` 以下
- `/4.for-developers/api/index.md` を分割
## APIリファレンスについて
API リファレンスは移動する予定ですmisskey-jsから自動生成
## 新しくDocsを作成するかたへ
Nuxtに変更したことに伴い、Canonical URLの統一のため、末尾にスラッシュが付くようになっています。
内部のリンクの切り分け処理が複雑になっているため、**絶対パスを使うようにしてください。**
なお、リンクは自動的に言語ごとのものに変換されますので、**マークダウン内で`/ja/`などの言語プレフィックスを付与しないようにしてください。**

View File

@ -1,33 +0,0 @@
---
description: 'アプリケーションが要求する権限の一覧'
---
# 権限の一覧
| Permisson | Description |
| --------------------- | ---------------------------- |
| `read:account` | アカウントの情報を見る |
| `write:account` | アカウントの情報を変更する |
| `read:blocks` | ブロックを見る |
| `write:blocks` | ブロックを操作する |
| `read:drive` | ドライブを見る |
| `write:drive` | ドライブを操作する |
| `read:favorites` | お気に入りを見る |
| `write:favorites` | お気に入りを操作する |
| `read:following` | フォローの情報を見る |
| `write:following` | フォロー・フォロー解除する |
| `read:messaging` | チャットを見る |
| `write:messaging` | チャットを操作する |
| `read:mutes` | ミュートを見る |
| `write:mutes` | ミュートを操作する |
| `write:notes` | ノートを作成・削除する |
| `read:notifications` | 通知を見る |
| `write:notifications` | 通知を操作する |
| `write:reactions` | リアクションを操作する |
| `write:votes` | 投票する |
| `read:pages` | ページを見る |
| `write:pages` | ページを操作する |
| `write:page-likes` | ページのいいねを操作する |
| `read:page-likes` | ページのいいねを見る |
| `write:gallery-likes` | ギャラリーのいいねを操作する |
| `read:gallery-likes` | ギャラリーのいいねを見る |

View File

@ -1,11 +0,0 @@
# 広告
Misskeyではサーバーによる広告をタイムラインなどに表示できる機能があります。
広告の右上に表示されるアイコンをクリックすることで、当該の広告の表示頻度を下げることができます。
:::tip
広告の総数が少ない場合は、表示頻度を下げた後も連続で表示される可能性があります。
:::
## 広告の設定(管理者)
サーバーのコントロールパネルから広告の追加、編集、削除を行えます。
広告には任意の画像、遷移先URL、形状、表示割合を設定できます。

View File

@ -1,4 +0,0 @@
# アンテナ
アンテナは、自由に条件を設定して、合致するノートを自動で収集することができる機能です。
条件を設定したアンテナが作成された状態で、条件に合致するノートが投稿されると、リアルタイムでそのアンテナのタイムラインにノートが追加されます。

View File

@ -1,57 +0,0 @@
# チャート
Misskeyはサーバーの様々なデータソースに対するチャートを生成し表示する機能を備えています。
チャートを利用することで、サーバーの利用状況や連合の状況、各ユーザーのアクティビティなどを視覚的に把握することができます。
サーバーのチャートはサーバー情報ページから表示することができます。
以下は各チャートとその各項目の説明です。
## 連合チャート
連合しているサーバー化ついてのチャートです。
### Pub
アクティビティを配送しているサーバーの数。
言い換えると、自サーバーのユーザーをフォローしているリモートユーザーの所属サーバーのユニークなカウントを表します。
### Sub
アクティビティを受信しているサーバーの数。
言い換えると、自サーバーのユーザーがフォローしているリモートユーザーの所属サーバーのユニークなカウントを表します。
### Received
アクティビティを送ってきたサーバーの数。
### Delivered
アクティビティを配送したサーバーの数。
### Stalled
アクティビティを配送する際、エラーになったサーバーの数。
## アクティブユーザー数チャート
自サーバーのユーザーの利用状況についてのチャートです。
### Read & Write
閲覧と書き込みを行ったユーザーの数。
### Read
閲覧を行ったユーザーの数。
### Write
書き込みを行ったユーザーの数。
### < Week
閲覧を行ったユーザーのうち、アカウント作成日時が1週間未満であるユーザーの数。
### < Month
閲覧を行ったユーザーのうち、アカウント作成日時が1ヶ月未満であるユーザーの数。
### < Year
閲覧を行ったユーザーのうち、アカウント作成日時が1年未満であるユーザーの数。
### > Week
閲覧を行ったユーザーのうち、アカウント作成日時が1週間以上前であるユーザーの数。
### > Month
閲覧を行ったユーザーのうち、アカウント作成日時が1ヶ月以上前であるユーザーの数。
### > Year
閲覧を行ったユーザーのうち、アカウント作成日時が1年以上前であるユーザーの数。

View File

@ -1,8 +0,0 @@
# クリップ
クリップは、複数のノートをまとめることができる機能です。自分のノート・他者のノートは問いません。
クリップは複数作ることができ、それぞれに名前や説明を設定して管理することが可能です。また、クリップを他のユーザーに公開するかどうかも選択することができます。
クリップを作るには、クリップ管理ページから「追加」をクリックします。
クリップにノートを追加するには、対象のノートのメニューから「クリップ」をクリックし、追加先のクリップを選択します。

View File

@ -1,7 +0,0 @@
# カスタム絵文字
カスタム絵文字は、サーバーで用意された画像を絵文字のように使える機能です。
ノート、リアクション、チャット、自己紹介、名前などの場所で使うことができます。
カスタム絵文字をそれらの場所で使うには、絵文字ピッカーボタン(ある場合)を押すか、`:`を入力して絵文字サジェストを表示します。
テキスト内に`:foo:`のような形式の文字列が見つかると、`foo`の部分がカスタム絵文字名と解釈され、表示時には対応したカスタム絵文字に置き換わります。
サーバーにどのようなカスタム絵文字が用意されているかは、Misskey Webの **サーバー情報** にある **カスタム絵文字** `/about#emojis`にアクセスすると見ることができます。

View File

@ -1,21 +0,0 @@
# デッキ
デッキは利用可能なUIのひとつです。「カラム」と呼ばれるビューを複数並べて表示させることで、カスタマイズ性が高く、情報量の多いUIが構築できることが特徴です。
なお、メインカラムを追加しておくと、ノートやプロフィールをページで表示した際、メインカラムに内容が表示されます。
## カラムの追加
デッキの背景を右クリックし、「カラムを追加」して任意のカラムを追加できます。
## カラムの移動
カラムは、ドラッグアンドドロップで他のカラムと位置を入れ替えることが出来るほか、カラムメニュー(カラムのヘッダー右クリック)から位置を移動させることもできます。
## カラムの水平分割
カラムは左右だけでなく、上下に並べることもできます。
カラムメニューを開き、「左に重ねる」を選択すると、左のカラムの下に現在のカラムが移動します。
上下分割を解除するには、カラムメニューの「右に出す」を選択します。
## カラムの設定
カラムメニューの「編集」を選択するとカラムの設定を編集できます。カラムの名前を変えたり、幅を変えたりできます。
## デッキの設定
デッキに関する設定は、[settings/deck](/settings/deck)で行えます。

View File

@ -1,23 +0,0 @@
# ドライブ
ドライブは、Misskey上でファイルを管理できる機能です。
:::tip
技術的に言うと、Misskeyのシステム上、すべてのファイルが一元管理されており、それをユーザーにも公開したインターフェイスがドライブと捉えることができます。
:::
Misskey Webのドライブページから任意のファイルをアップロードできるほか、アバターに設定した画像や、ートに添付したファイルなどもすべてドライブにアップロードされます。
ドライブにアップロードされたファイルは、いつでもダウンロードすることができるほか、ノート作成時に「ドライブからファイルを添付」することでファイルを再利用することもできます。
ドライブ内にフォルダを作り、複数のファイルをまとめて整理することもできます。
:::warning
現時点で、ドライブからファイルを削除すると、そのファイルが添付された **すべてのコンテンツ(ノート、ページなど)** も同時に消えます。
:::
## 閲覧注意 (NSFW)
閲覧注意またはNSFW (Not safe for work) は、ドライブのファイルに設定することができるフラグです。
閲覧注意フラグを設定されたファイルは、表示される際に閲覧者の操作なしには表示されなくなります。
このフラグは、例えば職場や公共の場で閲覧するのに適切でないと思われる画像などに設定し、そのような画像が突然表示されてしまうことを防ぐ目的で使われます。
このフラグは手動でオンオフを切り替えられるほか、モデレーターの判断で設定される場合もあります。

View File

@ -1,7 +0,0 @@
# お気に入り
[ノート](./note)をお気に入りとして登録できる機能です。
お気に入り登録したノートは、[お気に入りページ](./my/favorites)で一覧することができます。
お気に入りに登録したことは相手に通知されず、お気に入りは自分しか見ることができません。
ノートをお気に入り登録するには、ノートメニューの「お気に入り」を押します。お気に入り解除するには、ノートメニューの「お気に入り解除」を押します。

View File

@ -1,3 +0,0 @@
# フォロー
ユーザーをフォローすると、タイムラインにそのユーザーの投稿が表示されるようになります。ただし、他のユーザーに対する返信は含まれません。
ユーザーをフォローするには、ユーザーページの「フォロー」ボタンをクリックします。フォローを解除するには、もう一度クリックします。

View File

@ -1,12 +0,0 @@
# ハッシュタグ
ハッシュタグとは、投稿に検索可能なタグをつけることができる機能の一つです。
世界ではじめてのハッシュタグ── #barcamp は、[2007年8月24日の午前4:25](https://twitter.com/chrismessina/status/223115412?lang=en)にクリス・メッシナ氏[@chrismessina@mastodon.xyz](https://mastodon.xyz/@chrismessina)によって考案されました。後にこの「ポンド記号`#`を用いて検索を容易にする」という案は、英語で「刻む、ハックする」を意味する「ハッシュ」と、「札」を意味する「タグ」を合わせた造語──「ハッシュタグ」として生まれ変わり、Twitter社に公式採用されました。ちなみにクリス・メッシナ氏が`#`を選んだ理由は、IRCのチャンネル名が`#`で始まることからの連想だからだそうです。
![Screenshot of Chris Messina's first hashtag tweet that says "how do you feel about using # (pound) for groups. As in #barcamp [msg]?"](/docs/messina_first_2007.png)
FediverseでのハッシュタグはTwitterやInstagramなどといった中央集権的なサービスとでのものと多少仕様が異なります。Fediverseでは全文検索が難しい場合などがあり、特定の投稿を探し出すのは困難ですが、投稿にハッシュタグがついていれば、その投稿をハッシュタグをたどって容易に見つけ出すことができます。また、投稿にハッシュタグをつけるだけで様々なサイトに自動で届けてくれるハッシュタグリレーと呼ばれるサービスなどが連合宇宙には存在し、ここではハッシュタグにそこそこの重みがあったりするのです。

View File

@ -1,3 +0,0 @@
# 機能
<MkIndex :sort="(a, b) => b.name - a.name"></MkIndex>

View File

@ -1 +0,0 @@
# メンション

View File

@ -1,136 +0,0 @@
---
description: 'MFMは、Misskeyの様々な場所で使用できる専用のマークアップ言語です。'
---
# MFM
MFMは、Markup language For Misskeyの略で、Misskeyの様々な場所で使用できる専用のマークアップ言語です。
:::tip
一部の構文はMarkdownやHTMLと互換性があります。
:::
## MFMが使用可能な場所の例
- ノート本文
- CW注釈
- ユーザーの名前
- ユーザーの自己紹介
## 構文
### メンション
アットマーク + ユーザー名で、特定のユーザーを示すことができます。
:::tip
メンションについての詳細は[こちら](./mention.md)を参照してください。
:::
```:no-line-numbers
@alice
```
```:no-line-numbers
@alice@example.com
```
### ハッシュタグ
ナンバーサイン + タグで、ハッシュタグを示すことができます。
:::tip
ハッシュタグについての詳細は[こちら](./hashtag.md)を参照してください。
:::
```:no-line-numbers
#misskey
```
### URL
URLを示すことができます。
```:no-line-numbers
https://example.com
```
### リンク
文章の特定の範囲を、URLに紐づけることができます。
```:no-line-numbers
[example link](https://example.com)
```
### カスタム絵文字
コロンでカスタム絵文字名を囲むと、カスタム絵文字を表示させることができます。
:::tip
カスタム絵文字についての詳細は[こちら](./custom-emoji.md)を参照してください。
:::
```:no-line-numbers
:misskey:
```
### 太字
文字を太く表示して強調することができます。
```:no-line-numbers
**太字**
```
### 目立たなくする
内容を小さく・薄く表示させることができます。
```:no-line-numbers
<small>MisskeyでFediverseの世界が広がります</small>
```
### 引用
内容が引用であることを示すことができます。
```:no-line-numbers
> MisskeyでFediverseの世界が広がります
```
### 中央寄せ
内容を中央寄せで表示させることができます。
```:no-line-numbers
<center>MisskeyでFediverseの世界が広がります</center>
```
### コード(インライン)
プログラムなどのコードをインラインでシンタックスハイライトします。
```:no-line-numbers
`<: "Hello, world!"`
```
### コード(ブロック)
複数行のプログラムなどのコードをブロックでシンタックスハイライトします。
```:no-line-numbers
~ (#i, 100) {
<: ? ((i % 15) = 0) "FizzBuzz"
.? ((i % 3) = 0) "Fizz"
.? ((i % 5) = 0) "Buzz"
. i
}
```
### 反転
内容を上下または左右に反転させます。
```:no-line-numbers
$[flip MisskeyでFediverseの世界が広がります]
$[flip.v MisskeyでFediverseの世界が広がります]
$[flip.h,v MisskeyでFediverseの世界が広がります]
```
### フォント
内容のフォントを指定することができます。
```:no-line-numbers
$[font.serif MisskeyでFediverseの世界が広がります]
$[font.monospace MisskeyでFediverseの世界が広がります]
$[font.cursive MisskeyでFediverseの世界が広がります]
$[font.fantasy MisskeyでFediverseの世界が広がります]
```
### ぼかし
内容をぼかすことができます。ポインターを上に乗せるとはっきり見えるようになります。
```:no-line-numbers
$[blur MisskeyでFediverseの世界が広がります]
```
### プレーン
内側の構文を全て無効にします。
```:no-line-numbers
<plain>**bold** @mention #hashtag `code` $[x2 🍮]</plain>
```
## 開発者向け情報
MFMのパーサー実装はライブラリとして公開されており、簡単にクライアントにMFMを組み込むことが可能です。
- [misskey-dev/mfm.js](https://github.com/misskey-dev/mfm.js) - JavaScriptパーサー実装

View File

@ -1,53 +0,0 @@
# ミュートとブロック
好みではないユーザーがいる場合は、ミュートを行うことでそのユーザーが自分から見えないようにすることができます。
また、より強力な措置として、ブロックを行うことでそのユーザーから自分のコンテンツが見えないようになるほか、自分に対して関わることができないようにすることができます。
ミュートされていることは相手は分かりませんが、ブロックされていることは相手に分かります。どちらを選ぶかはご自身の判断で行ってください。
:::tip
ミュートとブロックは併用できます。
:::
:::warning
利用規約に違反するような、迷惑なユーザーがいる場合は運営者に報告することも検討してください。
:::
Misskey Webでは、設定>ミュートとブロック から、自分がミュートまたはブロックしているユーザー一覧を確認することができます。
## ミュート
ユーザーをミュートすると、そのユーザーに関する次のコンテンツがMisskeyに表示されなくなります:
- タイムラインや投稿の検索結果内の、そのユーザーの投稿(およびそれらの投稿に対する返信やRenote)
- そのユーザーからの通知
- メッセージ履歴一覧内の、そのユーザーとのメッセージ履歴
- など
Misskey Webでユーザーをミュートするには、対象のユーザーのユーザーページのメニューを開き、「ミュート」ボタンを押します。
:::tip
ミュートを行ったことは相手に通知されず、ミュートされていることを知ることもできません。
:::
## ブロック
ユーザーをブロックすると、そのユーザーからあなたのコンテンツが見えないようになり、またあなたに対して以下のようなアクションをすることができなくなります。
- フォローする
- ユーザーリストに追加する
- 返信する、Renoteする
- リアクションする、アンケートに投票する
- メッセージを送信する
- など
また、
- ブロックする際に既にそのユーザーからフォローされていた場合はフォローが解除されます。
- ブロックする際に既にそのユーザーがあなたをユーザーリストに入れていた場合はそのリストからあなたが削除されます。
Misskey Webでユーザーをブロックするには、対象のユーザーのユーザーページのメニューを開き、「ブロック」ボタンを押します。
:::warning
ブロックを行ったこと自体は相手に通知されませんが、フォローを行ったりなどの上記のアクションが行えなくなるので間接的にブロックされていることは分かります。
:::
:::warning
相手から自分のコンテンツが見えなくなりますが、相手がアカウントを切り替えたりログアウト状態になれば見ることができます。あくまで簡易的、補助的なものとしてお考えください。
:::

View File

@ -1,83 +0,0 @@
# ノート
ートは、Misskeyに投稿される、文章、ファイル、アンケートなどを含むコンテンツで、Misskeyの中心的概念です。また、そのートを作成する行為自体もートと呼ばれます。
:::tip
ノートという名称は、英語で「短い記録」を意味する Note が由来になっています。
:::
ノートが作成されると、[タイムライン](./timeline)に追加され、自分の[フォロワー](./follow)やサーバーのユーザーが見れるようになります。
ノートには、[リアクション](./reaction)を行うことができます。また、返信や引用もできます。
ノートを[お気に入り](./favorite)登録することで、後で簡単に見返すことができます。
## ノートを作成する
Misskey Webでートを作成するには、画面上にある鉛筆マークのボタンを押して、作成フォームを開きます。作成フォームに内容を入力し、「ート」ボタンを押すことでートが作成されます。
ノートには、画像、動画など任意のファイルや、[アンケート](./poll)を添付することができます。また、本文中には[MFM](./mfm)が使用でき、[メンション](./mention)や[ハッシュタグ](./hashtag)を含めることもできます。
他にも、CWや公開範囲といった設定も行えます(詳細は後述)。
:::tip
Misskey Webでは、コンピューターのクリップボードに画像データがある状態で、フォーム内のテキストボックスにペーストするとその画像を添付することができます。
:::
:::tip
Misskey Webでは、テキストボックス内で<kbd class="key">Ctrl + Enter</kbd>を押すことでも投稿できます。
:::
## Renote
既にあるートを引用、もしくはそのートを新しいートとして共有する行為、またそれによって作成されたートをRenoteと呼びます。
自分がフォローしているユーザーの、気に入ったノートを自分のフォロワーに共有したい場合や、過去の自分のノートを再度共有したい場合に使います。
同じートに対して無制限にRenoteを行うことができますが、あまり連続して使用すると迷惑になる場合もあるので、注意しましょう。
:::warning
公開範囲がフォロワーやダイレクトのートはRenoteできません。
:::
Misskey WebでRenoteを削除するには、Renoteの時刻表示の隣にある「...」を押し、「Renote解除」を選択します。
## CW
Contents Warningの略で、ートの内容を、閲覧者の操作なしには表示しないようにできる機能です。主に長大な内容を隠すためや、ネタバレ防止などに使うことができます。
Misskey WebでCWを設定するには、フォームの「内容を隠す」ボタン(目のアイコン)を押します。すると新しい入力エリアが表れるので、そこに内容の要約を記入します。
## 公開範囲
ノートごとに、そのノートが公開される範囲を設定することができます。
Misskey Webで公開範囲を設定するには、フォームの「ート」ボタンの左にあるアイコンを押します。
公開範囲には、以下の種類があります。
### パブリック
全ての人に対してノートが公開されるほか、サーバーの全てのタイムライン(ホームタイムライン、ローカルタイムライン、ソーシャルタイムライン、グローバルタイムライン)にノートが流れます。
:::warning
アカウントが[サイレンス](./silence)状態の時は、この公開範囲は使用できません。
:::
### ホーム
全ての人に対してノートが公開されますが、フォロワー以外のローカルタイムライン、ソーシャルタイムライン、グローバルタイムラインにはノートは流れません。
### フォロワー
自分のフォロワーに対してのみノートを公開します。フォロワーの全てのタイムラインに流れます。
### ダイレクト
指定したユーザーに対してのみノートを公開します。指定したユーザーの全てのタイムラインに流れます。
### 「ローカルのみ」オプション
このオプションを有効にすると、リモートにノートを連合しなくなります。
### 公開範囲の比較
<table>
<tr><th></th><th>パブリック</th><th>ホーム</th><th>フォロワー</th><th>ダイレクト</th></tr>
<tr><th>フォロワーのLTL/STL/GTL</th><td></td><td></td><td></td><td></td></tr>
<tr><th>非フォロワーのLTL/STL/GTL</th><td></td><td></td><td></td><td></td></tr>
</table>
## ピン留め
ノートをピン留めすると、ユーザーページに常にそのノートを表示しておくことができます。
Misskey Webでピン留めを行うには、ートのメニューを開き、「ピン留め」を選択します。
:::tip
複数のノートを同時にピン留めすることも可能です。
:::
## ウォッチ
ノートをウォッチすると、自分以外のノートへのリアクションや返信などの通知を受け取ることができます。
Misskey Webでウォッチするには、ートのメニューを開き、「ウォッチ」を選択します。

View File

@ -1,38 +0,0 @@
# オンラインステータス
ユーザーの**オンラインステータス**は、そのユーザーのMisskey利用の状態を表すものです。
オンラインステータスは、ユーザーページなどでユーザーアイコンの隅にインジケーターとして表示されます。
<table>
<tr>
<th></th>
<th>状態</th>
<th>説明</th>
</tr>
<tr>
<td>🟢緑</td>
<td>オンライン</td>
<td>今まさにMisskeyを使用していると考えられる状態</td>
</tr>
<tr>
<td>🟡黄</td>
<td>アクティブ</td>
<td>今は退席しているものの、Misskeyの利用自体は行われている状態</td>
</tr>
<tr>
<td>🔴赤</td>
<td>オフライン</td>
<td>Misskeyを利用していないと考えられる状態</td>
</tr>
<tr>
<td>⚫灰</td>
<td>不明</td>
<td>ステータスを非公開にしている、もしくはリモートユーザー等でステータスが不明の状態</td>
</tr>
</table>
オンラインステータスは自動的に変わり、手動で設定することは出来ません。
設定により、オンラインステータスを非公開にすることができます。
:::warning
ユーザーのサジェストなど、一部の機能においてはオンラインステータスを元に処理される場合があるため、ステータスを非公開にすると他のユーザーから見つけにくくなることがあります。
:::

View File

@ -1,65 +0,0 @@
# ページ
Misskey上でートとは別にページを作成できます。v13では静的ページに特化しています。
:::warning
v13よりページによる動的ページ作成の代わりにMisskey Playが使用できます。
:::
## ページ設定
ページに関する項目を設定します。次の項目を入力できます。
- タイトル
- ページの要約
- ページURL
- 中央寄せ
- フォント
- ピン留めされているときにタイトルを非表示
- アイキャッチ画像
### タイトル
このページのタイトルを入力します。一覧に表示されます。
### ページの要約
簡単な説明を入力します。一覧に表示されます。
### ページURL
`https://サーバー名/@ユーザー/pages/●●●``●●●` を任意に設定できます。
### 中央寄せ
有効にすると、中央に寄せて表示します。
### フォント
**セリフ** と **サンセリフ** を選択します。
### ピン留めされているときにタイトルを非表示
ピン留めされているときにタイトルを非表示にします。
### アイキャッチ画像
**アイキャッチ画像を設定** より画像を設定できます。一覧表示などで表示する事が可能です。
## コンテンツ
ページ本体を編集します。次のブロックを一つまたは複数組み合わせてページを生成できます。
- セクション
- テキスト
- 画像
- ノート埋め込み
### セクション
タイトルを設定する事で見出しとして表示します。更に中のブロックを設定できます。
### テキスト
テキスト本文を入力します。MFMやカスタム絵文字を使用できます。
### 画像
画像を表示します。ドライブより画像を設定します。
### ノート埋め込み
ノート ID を入れる事で、そのートを表示します。他のサーバーを埋め込みたい場合は検索でそのURLを入れ、表示させた時のIDを貼り付けて下さい。

View File

@ -1,4 +0,0 @@
# プラグイン
Misskey Webにはプラグイン機能があり、ユーザーがMisskey Webの機能を拡張することができます。
プラグインの作成方法については[こちらのドキュメント](../advanced/create-plugin.md)を参照してください。

View File

@ -1,18 +0,0 @@
# リアクション
他の人のノートに、絵文字を付けて簡単にあなたの反応を伝えられる機能です。
Misskey Webでリアクションするには、ートの + アイコンをクリックしてピッカーを表示し、絵文字を選択します。
リアクションには[カスタム絵文字](./custom-emoji.md)も使用できます。
## リアクションピッカーのカスタマイズ
Misskey Webでは、ピッカーに表示される絵文字を自分好みにカスタマイズすることができます。
設定の「リアクション」で設定します。
## リモート投稿へのリアクションについて
リアクションはMisskeyオリジナルの機能であるため、リモートサーバーがMisskeyでない限りは、ほとんどの場合「Like」としてアクティビティが送信されます。一般的にはLikeは「お気に入り」として実装されているようです。
## リモートからのリアクションについて
リモートから「Like」アクティビティを受信したとき、Misskeyでは「👍」のリアクションとして解釈されます。
## 自分のリアクション一覧を見る
Misskey Webでは、自分のプロフィールページの「リアクション」タブを開くことで、自分の行ったリアクション一覧を見ることができます。
設定から、このリアクション一覧を公開するようにすることもできます。

View File

@ -1,53 +0,0 @@
# 共有フォーム
Misskey Webの`/share`を開くと、共有用の投稿フォームを開くことができます。この共有フォームを利用すると、外部のWebページから、ページの内容をユーザーにMisskeyで共有してもらいたいときに便利です。
URLにクエリパラメータとして共有内容をはじめとするいくつかのオプションを指定できます。
## クエリパラメータ
:::tip
すべてのパラメータは**オプション**であり、必須ではありません。
:::
| 名前 | 説明 |
| ---- | ---- |
| `title` | タイトル。本文の先頭に[ … ]と挿入されます。 |
| `text` | 本文。 |
| `url` | URL。本文の末尾に挿入されます。 |
### リプライ情報
以下のいずれかを指定すると、指定のノートに対するリプライにすることができます。
| 名前 | 説明 |
| ---- | ---- |
| `replyId` | リプライ先のートID。 |
| `replyUri` | リプライ先のURL。リモートのートオブジェクトを指定 |
### Renote情報
以下のいずれかを指定すると、指定のートに対するRenote(引用)にすることができます。
| 名前 | 説明 |
| ---- | ---- |
| `renoteId` | Renote先のートID。 |
| `renoteUri` | Renote先のURL。リモートのートオブジェクトを指定 |
### 公開範囲
以下のオプションで公開範囲の指定を行えます。
| 名前 | 説明 |
| ---- | ---- |
| `visibility` | `public`, `home`, `followers`, `specified` のいずれか |
| `localOnly` | 0(false) or 1(true) |
| `visibleUserIds` | 対象ユーザーID(カンマ区切り) |
| `visibleAccts` | 対象ユーザー[acct](../glossary.md#acct)(カンマ区切り) |
:::warning
`visibility`に`specified`を指定した場合は、`visibleUserIds`または`visibleAccts`の指定も必要です。
:::
### 添付ファイル
以下のオプションで添付ファイルの指定を行えます。
| 名前 | 説明 |
| ---- | ---- |
| `fileIds` | 添付するファイルのID(カンマ区切り) |

View File

@ -1,7 +0,0 @@
# サイレンス
サイレンスは、アカウントに設定される状態のひとつです。
アカウントがサイレンス状態になると、ノートの公開範囲をパブリックにできなくなります。
ホーム、フォロワー、ダイレクトは選択可能なため、サイレンスを受けた場合でもフォロワーやあなたのユーザーページを直接訪れた場合は投稿を閲覧できますが、GTL(連合タイムライン)やLTL(ローカルタイムライン)には投稿が流れません。
アカウントのサイレンス状態は、サーバーのモデレーターによって有効化/無効化されます。

View File

@ -1,95 +0,0 @@
# テーマ
テーマを設定して、Misskeyクライアントの見た目を変更できます。
## テーマの設定
設定 > テーマ
## テーマを作成する
テーマコードはJSON5で記述されたテーマオブジェクトです。
テーマは以下のようなオブジェクトです。
``` js
{
id: '17587283-dd92-4a2c-a22c-be0637c9e22a',
name: 'Danboard',
author: 'syuilo',
base: 'light',
props: {
accent: 'rgb(218, 141, 49)',
bg: 'rgb(218, 212, 190)',
fg: 'rgb(115, 108, 92)',
panel: 'rgb(236, 232, 220)',
renote: 'rgb(100, 152, 106)',
link: 'rgb(100, 152, 106)',
mention: '@accent',
hashtag: 'rgb(100, 152, 106)',
header: 'rgba(239, 227, 213, 0.75)',
navBg: 'rgb(216, 206, 182)',
inputBorder: 'rgba(0, 0, 0, 0.1)',
},
}
```
* `id` ... テーマの一意なID。UUIDをおすすめします。
* `name` ... テーマ名
* `author` ... テーマの作者
* `desc` ... テーマの説明(オプション)
* `base` ... 明るいテーマか、暗いテーマか
* `light`にすると明るいテーマになり、`dark`にすると暗いテーマになります。
* テーマはここで設定されたベーステーマを継承します。
* `props` ... テーマのスタイル定義。これから説明します。
### テーマのスタイル定義
`props`下にはテーマのスタイルを定義します。
キーがCSSの変数名になり、バリューで中身を指定します。
なお、この`props`オブジェクトはベーステーマから継承されます。
ベーステーマは、このテーマの`base`が`light`なら[_light.json5]で、`dark`なら[_dark.json5]です。
つまり、このテーマ内の`props`に`panel`というキーが無くても、そこにはベーステーマの`panel`があると見なされます。
[_light.json5]: https://github.com/misskey-dev/misskey/blob/develop/packages/frontend/src/themes/_light.json5
[_dark.json5]: https://github.com/misskey-dev/misskey/blob/develop/packages/frontend/src/themes/_dark.json5
#### バリューで使える構文
* 16進数で表された色
* 例: `#00ff00`
* `rgb(r, g, b)`形式で表された色
* 例: `rgb(0, 255, 0)`
* `rgb(r, g, b, a)`形式で表された透明度を含む色
* 例: `rgba(0, 255, 0, 0.5)`
* 他のキーの値の参照
* `@{キー名}`と書くと他のキーの値の参照になります。`{キー名}`は参照したいキーの名前に置き換えます。
* 例: `@panel`
* 定数(後述)の参照
* `${定数名}`と書くと定数の参照になります。`{定数名}`は参照したい定数の名前に置き換えます。
* 例: `$main`
* 関数(後述)
* `:{関数名}<{引数}<{色}`
#### 定数
「CSS変数として出力はしたくないが、他のCSS変数の値として使いまわしたい」値があるときは、定数を使うと便利です。
キー名を`$`で始めると、そのキーはCSS変数として出力されません。
#### 関数
「ボタンの上にカーソルを合わせたときだけ色を明るくしたい」のように、既存の色から少し変更した色を使いたい場合に、関数を使うと便利です。
`:{関数名}<{引数}<{色や他のキーの参照}`の形で使うことができます。
```js
props: {
accent: '#86b300',
accentDarken: ':darken<10<#86b300',
accentLighten: ':lighten<10<@accent'
}
```
##### 使用できる関数
* `lighten` ... 渡された色の輝度(0~100)に対して引数(0~100)を加算した色を返します。
* `darken` ... 渡された色の輝度(0~100)に対して引数(0~100)を減算した色を返します。
* `alpha` ... 渡された色の透明度を引数(0.0~1.0)に設定した色を返します。
* 0.0のとき完全に透明、1.0で完全に不透明になります。
* `hue` ... 渡された色の色相(-360~360)に対して引数(-360~360)の値だけ回転させた色を返します。
* `saturate` ... 渡された色の彩度(0~100)に対して引数(0~100)を加算した色を返します。

View File

@ -1,14 +0,0 @@
# スレッドミュート
:::tip
バージョン 12.95.0 以降の機能です。
:::
スレッドミュートは、指定したノートのスレッドをミュートします。スレッドとは、起点のノートから繋がった全てのリプライのことです。
スレッドをミュートすると、そのスレッドへの新たなリプライおよびリプライに含まれるあなた宛てのメンションが、通知されなくなるほか「あなた宛て」にも載らなくなります。
Misskey Webでスレッドをミュートするには、対象のスレッドに属する任意のートもしくは起点のートのメニューを開き、「スレッドをミュート」を選択します。
:::warning
スレッド内のどのノートからミュート操作を行ったかに関わらず、そのスレッド全体がミュートされます。
:::

View File

@ -1,33 +0,0 @@
# タイムライン
タイムラインは、[ノート](./note)が時系列で表示される機能です。
タイムラインには以下で示す種類があり、種類によって表示されるノートも異なります。
なお、タイムラインの種類によってはサーバーにより無効になっている場合があります。
## ホーム
自分のフォローしているユーザーの投稿が流れます。HTLと略されます。
## ローカル
全てのローカルユーザーの「ホーム」指定されていない投稿が流れます。LTLと略されます。
## ソーシャル
自分のフォローしているユーザーの投稿と、全てのローカルユーザーの「ホーム」指定されていない投稿が流れます。STLと略されます。
## グローバル
全てのローカルユーザーの「ホーム」指定されていない投稿と、サーバーに届いた全てのリモートユーザーの「ホーム」指定されていない投稿が流れます。GTLと略されます。
## 比較
| ソース | | | タイムライン | | |
|-----------------------|------------|--------|---------|------------|------------|
| ユーザー | 公開範囲 | ホーム | ローカル | ソーシャル | グローバル |
| ローカル (フォロー) | 公開 | ✔ | ✔ | ✔ | ✔ |
| | ホーム | ✔ | | ✔ | |
| | フォロワー | ✔ | | ✔ | |
| リモート (フォロー) | 公開 | ✔ | | ✔ | ✔ |
| | ホーム | ✔ | | ✔ | |
| | フォロワー | ✔ | | ✔ | |
| ローカル (未フォロー) | 公開 | | ✔ | ✔ | ✔ |
| | ホーム | | | | |
| | フォロワー | | | | |
| リモート (未フォロー) | 公開 | | | | ✔ |
| | ホーム | | | | |
| | フォロワー | | | | |

View File

@ -1,145 +0,0 @@
# Webhook
:::tip
バージョン 12.109.0 以降の機能です。
:::
:::warning
実験的な機能であるため、動作が不安定だったり今後仕様が変更される可能性があります。
:::
MisskeyにはWebhookが用意されています。Webhookを利用すると、Misskey上の様々なイベントをリアルタイムに受け取ることが可能です。
設定>Webhook でWebhookの管理を行えます。
Webhookが登録されると、指定したイベントが発生した際に、指定したURLにHTTPリクエストが送信されます。リクエストのメソッドはPOSTで、ボディはJSONです。
さらに、リクエストヘッダーには`X-Misskey-Hook-Secret`という名前で、登録時に設定したシークレットが含まれます。このシークレットが正しいか検証することで、リクエストが正規のものか判定することができます。
リクエストペイロードは以下のプロパティが入ります。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
hookId: {
type: 'string',
description: 'Webhook ID',
},
userId: {
type: 'string',
description: 'Webhook作成者のユーザーID',
},
eventId: {
type: 'string',
description: 'イベントのID',
},
createdAt: {
type: 'integer',
description: 'イベントが発生した日時(UNIX time、ミリ秒)',
},
type: {
type: 'string',
description: 'イベントの種類',
},
body: {
type: 'object',
description: 'イベントのペイロード',
},
}
}"/>
送信先サーバーが5xxエラーを返すか、応答しなかった場合は時間を開けてリクエストが再送されます。
Webhookは管理画面から個別にアクティブ状態を設定でき、一時的にリクエストの送信を停止させることができます。
## イベント
イベントごとに説明とペイロードを示します。
### follow
自分が誰かをフォローした際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
user: {
$ref: 'misskey://User',
description: 'フォローしたユーザー',
},
}
}"/>
### followed
自分が誰かからフォローされた際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
user: {
$ref: 'misskey://User',
description: 'フォローを行ったユーザー',
},
}
}"/>
### unfollow
自分が誰かをフォロー解除した際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
user: {
$ref: 'misskey://User',
description: 'フォロー解除したユーザー',
},
}
}"/>
### note
自分がノートを投稿した際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
note: {
$ref: 'misskey://Note',
description: '作成されたノート',
},
}
}"/>
### reply
自分のノートに返信された際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
note: {
$ref: 'misskey://Note',
description: '返信',
},
}
}"/>
### renote
自分のートがRenoteされた際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
note: {
$ref: 'misskey://Note',
description: 'Renote',
},
}
}"/>
### mention
自分にメンションされた際に発生します。
<MkSchemaViewerItemObject :schema="{
type: 'object',
properties: {
note: {
$ref: 'misskey://Note',
description: 'メンションを含むノート',
},
}
}"/>

View File

@ -1,138 +0,0 @@
# ウィジェット
ウィジェットは、MisskeyのUI上に設置できる小型の情報表示、操作が行えるパーツです。
ウィジェットを編集するには、ウィジェット編集モードに切り替えます。切り替え方法はUIによって異なります。
ウィジェット編集モードでは、ウィジェットの追加、削除、並び替え、およびそれぞれのウィジェットの設定を行えます。
## 利用可能なウィジェット一覧
- プロフィール
- サーバー情報
- 付箋
- タイムライン
- カレンダー
- RSSリーダー
- RSSティッカー
- トレンド
- 時計
- アクティビティ
- フォト
- デジタル時計
- UNIX時計
- 連合
- サーバークラウド
- 投稿フォーム
- スライドショー
- サーバーメトリクス
- オンラインユーザー
- ジョブキュー
- ボタン
- AiScriptコンソール
- AiScript App
- 藍
- ユーザーリスト
- クリッカー
### プロフィール
名前・ユーザー名・アバター画像・バナー画像を表示します。複数アカウントを使用している時に使用しているユーザー名が見やすくなります。
### サーバー情報
サーバー名・ドメイン・アイコン画像・バナー画像を表示します。
### 付箋
テキストを保存しておけます。
### タイムライン
ライムラインを表示します。ホーム・ローカル・ソーシャル・グローバルを切り替え表示できます。
### カレンダー
今日の年月日・曜日、今日・今月・今年をパーセント表示します。デフォルトUIでは最初から表示されています。
### RSSリーダー
RSS フィードタイトルを一覧表示します。
### RSSティッカー
RSS フィードを順次スクロール表示します。
### トレンド
最近よく使用されているハッシュタグを表示します。
### 時計
アナログ時計で現在時間を表示します。
### アクティビティ
稼働状況をドット表示します。
### フォト
最近のドライブ中身を表示します。
### デジタル時計
デジタル時計で現在時刻を表示します。
### UNIX時計
UNIX時間で現在時刻を表示します。
### 連合
主に通信している他のサーバーを表示します。
### サーバークラウド
他のサーバーを球状に表示します。
### 投稿フォーム
ノートを投稿するッフォーム を固定表示します。
### スライドショー
ドライブ内の特定フォルダ内を順次表示します。
### サーバーメトリクス
サーバのCPU・メモリ・ネット送受・ストレージ容量を表示します。サーバ環境によっては表示できない場合があります。
### オンラインユーザー
現在オンタイン状態になっているユーザー数表示します。
### ジョブキュー
他サーバーとの送受しているノートなどのキュー状態を表示します。
### ボタン
ボタンを表示します。動作は AIScript で記載していきます。
### AiScriptコンソール
AiScript を実行できるコンソールを表示します。
### AiScript App
AIScript ソースを用いてアプリを表示します。Misskey Play と同じ UI を使用できます。v13 より追加されています。
### 藍
藍を表示します。カーソルに合わせて視線を変えたりします。
### ユーザーリスト
リストを表示します。もっと! - リスト で設定できます。
### クリッカー
クッキーを表示します。表示されたクッキーをクリック・タップして下さい。

View File

@ -1,20 +0,0 @@
# ワードミュート
ワードミュートの設定をすると、条件に合致したノートが表示されなくなります。
ワードミュートには、ソフトワードミュートとハードワードミュートの2種類があります。それぞれについて設定の方法と挙動を説明します。
## ソフトワードミュート
ソフトワードミュートは、クライアント(アプリ)側でミュートを判断するワードミュートです。
ノートが設定した条件に合致すると、「(ユーザー名)が何かを言いました」という表示で隠れます。
クリックすると元の通りに表示されます。
## ハードワードミュート
ハードワードミュートは、アンテナのようにサーバーが新しいノートの本文に対して条件に合致するかどうか判断し、タイムラインから対象となったノートを除外します。
つまり、ハードワードミュートには、以下のような特徴があります。
- 条件設定後、新しい投稿のみがミュートの対象になります。
- 条件を変更しても、過去にハードミュートされたノートはミュートされたままになります。
- 「○○が何かを言いました」でタイムラインが埋まることがありません。
- ソフトミュートに非対応のアプリでも、ハードミュートは適用されます。

View File

@ -1,124 +0,0 @@
---
description: 'Misskeyについてのドキュメントです。'
---
# Misskeyについて
Misskeyはオープンソースの分散型マイクロブログプラットフォームプロジェクトです。
開発は日本でsyuiloによって2014年から開始されました。
ドライブ、リアクションなどの豊富な機能や、高いカスタマイズ性を備えたUIを持つことが特徴です。
## 歴史
開発当初は掲示板がメインのサービスでしたが、ユーザーが短文を投稿し、それを時系列で流れるタイムライン機能を追加したところ人気が高まり、徐々にそれがメインとして開発が進むようになりました。
当初は分散型ではありませんでしたが、2018年にActivityPubを実装し分散型になったことで、より多くの方に認知され利用されるサービスになり、現在に至ります。
:::tip
Misskeyという名前は、syuiloが当時聴いていたMay'nというアーティストの楽曲、Brain Diverの歌詞に由来します。
:::
誰でも開発に参加することができ、現在でも活発に開発が続いています。
## 分散型とは何か?
<b>分散(distributed)型</b>とは、<b>非中央集権(decentralized)</b>とも呼ばれ、コミュニティが多数のサーバーに分散して存在し、それらが相互に<b>通信(連合、federation)</b>することでコンテンツ共有<b>ネットワーク(Fediverse)</b>を形成していることが特徴のサービスです。
単一のサーバーしか存在しない、もしくは複数存在しても互いに独立している場合は中央集権なサービスと言われ、例えばTwitterやFacebookなどほとんどのサービスがそれに該当します。
分散型のメリットは、自分に合った運営者やテーマのサーバーを選択できることです。自分でサーバーを作成することもできます。連合するおかげで、どのサーバーを選んでも、同じコミュニティにアクセスできます。
## 常にオープンソース
Misskeyはこれまでもこれからも、オープンソースであり続けます。オープンソースとは、簡単に言うと<b>ソフトウェアのソースコード(プログラム)が公開されている</b>ことです。ソースコードの修正や再配布が可能であることを定義に含めることもあります。
Misskeyのすべてのソースコードは[AGPL](https://github.com/misskey-dev/misskey/blob/develop/LICENSE)というオープンソースライセンスの下に[公開](https://github.com/misskey-dev)されていて、誰でも自由に閲覧、使用、修正、改変、再配布をすることができます。
オープンソースは、自分で好きなように変えたり、有害な処理が含まれていないことを確認することができたり、誰でも開発に参加できるなどの、様々なメリットがあります。
上述の分散型を実現するためにも、オープンソースであるということは必要不可欠な要素です。
再び引き合いに出しますが、TwitterやFacebookなどの利益を得ているほとんどのサービスはオープンソースではありません。
:::tip
技術的に言うと、MisskeyのソースコードはGitで管理されていて、リポジトリは[GitHub上でホスティングされています。](https://github.com/misskey-dev)
:::
## 開発に参加する、プロジェクトを支援する
Misskeyを気に入っていただけたら、ぜひプロジェクトを支援してください。プロジェクトに貢献するには、以下で紹介するようにいろいろな方法があります。方法によっては開発のスキルは不要なので、誰でも気軽に参加し貢献することができます。いつでもお待ちしています。
### 機能を追加したり、バグを修正する
ソフトウェアエンジニアのスキルをお持ちの方であれば、ソースコードを編集する形でプロジェクトに貢献することができます。
貢献についてのガイドは[こちら](https://github.com/misskey-dev/misskey/blob/develop/CONTRIBUTING.md)です。
### 議論に参加する
新しい機能、または既存の機能について意見を述べたり、不具合を報告したりすることでも貢献できます。
そのようなディスカッションは[GitHub](https://github.com/misskey-dev)上か、[フォーラム](https://forum.misskey.io/)等で行われます。
### テキストを翻訳する
Misskeyは様々な言語に対応しています(i18n -internationalizationの略- と呼ばれます)。元の言語は基本的に日本語ですが、有志によって他の言語へと翻訳されています。
その翻訳作業に加わっていただくことでもMisskeyに貢献できます。
Misskeyは[Crowdinというサービスを使用して翻訳の管理を行っています。](https://crowdin.com/project/misskey)
### 感想を投稿する
不具合報告等だけではなく、Misskeyの良い点、楽しい点といったポジティブな意見もぜひ共有してください。開発の励みになり、それは間接的ですがプロジェクトへの貢献です。
### ミスキストを増やす
ミスキストとは、Misskeyを使用する人のことです。
知り合いに紹介するなどしてMisskeyを広めていただければ、ミスキストが増え開発のモチベーションが上がります。
### 寄付をする
[こちらをご覧ください](./donate.md)
## よくある質問
### プロジェクトは何を目指していますか?
強いて言うと、漠然的になりますが広く使われる汎用的なプラットフォームになることを目指しています。
Misskeyは他のプロジェクトとは違い、何らかの思想(例えば、反中央集権)やビジョンに基づいて開発が行われているわけではなく、その点ではフラットです。
それが逆に、特定の方向性に縛られないフレキシブルさを生み出すことに繋がっていると感じています。
<!-- TODO: ここにロードマップへのリンク -->
### 企業によって開発されていますか?
いいえ。Misskeyの開発は個人で行われており、商業的でもないため、特定の企業の関りはありません。
開発メンバーも基本的にはボランティアです。
また、開発に対し企業のスポンサーがつくこともありますが、その場合でもやはり開発は個人のコミュニティが主体です。
### 誰が運営していますか?
Misskeyは分散型なため、各サーバーにそれぞれ異なった運営者がいます。従って、特定の個人や企業によって、Misskeyの全てが運営されているわけではありません。
また、開発チームが運営を行うわけでもないため、運営に関する連絡は、お使いのサーバーの運営者に行ってください。
サーバーの運営者は、サーバーの情報ページで確認することができます。
あなたがサーバーを作成すれば、あなたが運営者になります。
### どのサーバーを選べばいいですか?
[サーバー一覧が公開されています。](../instances.md)
サーバーによってコミュニティのテーマ(特定のこと、ものが好き 等)が決められている場合があるので、自分に合ったテーマのサーバーがあれば、そこを選ぶと良いかもしれません。
他にも、サーバーの規模、ユーザー層、国および言語、運営者が信頼できるかどうか、などの観点があります。
なお、Misskey公式のサーバーというものはありません。自身で新しくサーバーを作成するという選択肢もあります。
基本的にどのサーバーを選んだとしても、他の全てのサーバーのユーザーと繋がることができます。
### サーバーを建てるにはどうしたらいいですか?
Misskeyサーバーの作成に興味を持っていただきありがとうございます。
2022年現在、Misskeyのホスティングサービスは存在しないため、サーバーの作成にはある程度の知識が必要です。
サーバーの作成方法については[こちら](./install.md)をご覧ください。
### どのような技術を使用していますか?
Misskeyは開発が進むにつれ使用する技術も大きく変わってきました。開発当初はMySQL + PHP + jQueryといった構成でしたが、現在は以下のようになっています。
- サーバーサイド: Node.js
- データベース: PostgreSQL、Redis
- UIフレームワーク: Vue.js
- プログラミング言語: TypeScript
また、MFMやAiScriptなどの、Misskeyから派生して独自の技術も開発しています。
### Mastodonのフォークですか
いいえ。MisskeyはMastodonやその他のプロジェクトとは全く別のプロジェクトです。
開発に関しても、Misskeyの方が昔から開発されています。ただし、分散型になったのはMastodonの登場より後です。
同じActivityPubという分散のためのプロトコルを実装しているという点以外、両者に特に関りがあるわけでもありません。
### iOS/Androidのアプリはありますか
公式にはそういったOSのネイティブアプリを開発していませんが、サードパーティ製のアプリがいくつかあります。
詳しくは[こちら](./apps.md)をご覧ください。
ただ、サードパーティ製アプリはどうしても機能への対応が遅れてしまうため、とくに拘りがなければ公式のWebクライアントの利用をおすすめします。
なお、MisskeyのWebクライアントはPWAに対応しているので、ネイティブアプリのように動作させることも可能です。
詳しくは[こちら](todo)をご覧ください。
### Misskeyのロゴ、アイコンはどこで入手できますか
[こちら](../appendix/assets.md)
### 時折目にする猫耳の可愛い女の子は?
Misskeyの守り神、藍ちゃんです。アイチャンカワイイヤッター!
:::tip
藍ちゃんについては[こちら](https://xn--931a.moe/)です。
:::

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,14 @@
# Misskeyをはじめよう
ここでは、Misskeyでの活動を始めるチュートリアルを掲載しています。
おもに、
- 分散型プラットフォームの注意点
- サーバーとは?サーバーの選び方は?
- 登録の手順
- 最低限の基礎知識
などについて解説していますので、この通りに進めることで、とりあえずMisskeyを使い始めることができると思います。
それでは、早速始めましょう!(「次へ」を押して進んでください。)

View File

@ -1,12 +1,12 @@
---
description: "Misskeyサーバーへのユーザー登録や、基本的な操作について解説しています。"
---
# Misskeyを始めよう
# Misskeyサーバーをさがす
Misskeyはソフトウェアおよびそのプロジェクトです。
インターネットに公開されている、Misskeyを動かしているサーバーのことを**サーバー**と呼びます。
Misskeyを利用するには、どこかのサーバーにアカウントを作成し、そのサーバーを利用します。
[サーバー一覧](../instances.md)から、好きなサーバーを選ぶことができます。
[サーバー一覧](/servers/)から、好きなサーバーを選ぶことができます。
:::tip
どのサーバーを選んでも、他のサーバーのユーザーとやり取りすることができます。

View File

@ -0,0 +1,34 @@
# サーバーに登録する
登録するサーバーが決まったら、さっそくアカウントを作成しましょう。
:::tip
ここでは、Misskey.ioを例にとって紹介していますが、他のサーバーでも登録方法はおおむね同じです。
ただし、入力事項はサーバーによって異なることがあります。詳しくは、サーバー管理者にお問い合わせください。
:::
## 登録する
まずは、トップページから「**このサーバーに登録する**」ボタンを探し、クリックします。
![このサーバーに登録ボタン](/img/docs/for-users/onboarding/join-server/1.ja.png)
次に、画面の指示に従い、規約の確認や必要事項の記入を進めてください。
主に記入すべき事項は、以下の通りです。
- 招待コード(登録が招待制の場合のみ。お持ちでない場合は登録できません。)
- ユーザー名(**後から変更はできません。一度退会すると同じユーザー名を取得することはできません。**
- メールアドレス(必要ないサーバーもあります)
- パスワード
![必要事項の記入](/img/docs/for-users/onboarding/join-server/2.ja.png)
必要事項の記入が終わると、メールアドレスを登録するサーバーの場合、確認メールが届きますので、速やかにメール内のリンクをクリックしてください。
![確認メール](/img/docs/for-users/onboarding/join-server/3.ja.png)
以上で、Misskey サーバーへの登録が完了しました!
これであなたも[ミスキスト](../resources/glossary/#ミスキスト)!楽しいコミュニケーションをお楽しみください。

View File

@ -0,0 +1,23 @@
# Misskeyの基礎知識
アカウントを作成したあなたにとりあえず知っておいてほしいことをまとめました!
## ノート
Misskeyへの投稿は、「ート」と呼ばれます。Twitterなどの一般的なSNSに比べたくさんの機能がありますので、初めての投稿を行う前に必ず確認して、上手に投稿しましょう
:::tip
詳細は、「[ノート](/docs/for-users/features/note/)」をご覧ください。
:::
## タイムライン
Misskeyは、複数のタイムラインを持っています。名前だけでは少々わかりにくいかと思いますので、それぞれがどのような働きをするのかを知っておきましょう。
:::tip
詳細は、「[タイムライン](/docs/for-users/features/timeline/)」をご覧ください。
:::
## その他
その他にも、Misskeyには、使って楽しい機能が盛りだくさんすべての機能に関する説明は[こちら](/docs/for-users/features/)に記載されていますので、ぜひご覧ください!

View File

@ -4,7 +4,7 @@
世界ではじめてのハッシュタグ── #barcamp は、[2007年8月24日の午前4:25](https://twitter.com/chrismessina/status/223115412?lang=en)にクリス・メッシナ氏[@chrismessina@mastodon.xyz](https://mastodon.xyz/@chrismessina)によって考案されました。後にこの「ポンド記号`#`を用いて検索を容易にする」という案は、英語で「刻む、ハックする」を意味する「ハッシュ」と、「札」を意味する「タグ」を合わせた造語──「ハッシュタグ」として生まれ変わり、Twitter社に公式採用されました。ちなみにクリス・メッシナ氏が`#`を選んだ理由は、IRCのチャンネル名が`#`で始まることからの連想だからだそうです。
![Screenshot of Chris Messina's first hashtag tweet that says "how do you feel about using # (pound) for groups. As in #barcamp [msg]?"](/docs/messina_first_2007.png)
![Screenshot of Chris Messina's first hashtag tweet that says "how do you feel about using # (pound) for groups. As in #barcamp [msg]?"](/img/docs/for-users/features/hashtag/1.ja.png)
FediverseでのハッシュタグはTwitterやInstagramなどといった中央集権的なサービスとでのものと多少仕様が異なります。Fediverseでは全文検索が難しい場合などがあり、特定の投稿を探し出すのは困難ですが、投稿にハッシュタグがついていれば、その投稿をハッシュタグをたどって容易に見つけ出すことができます。また、投稿にハッシュタグをつけるだけで様々なサイトに自動で届けてくれるハッシュタグリレーと呼ばれるサービスなどが連合宇宙には存在し、ここではハッシュタグにそこそこの重みがあったりするのです。

View File

@ -8,7 +8,7 @@
## テーマを作成する
テーマコードはJSON5で記述されたテーマオブジェクトです。
テーマは以下のようなオブジェクトです。
``` js
```js
{
id: '17587283-dd92-4a2c-a22c-be0637c9e22a',

View File

@ -0,0 +1,2 @@
title: "その他のリソース"
description: "機能面以外の知識や、困ったときの対処法を紹介しています。"

View File

@ -5,10 +5,8 @@ Misskey Hubは、Misskeyに関するナレッジなどのドキュメント、
Misskey Hubも[オープンソースで公開されています。](https://github.com/misskey-dev/misskey-hub)
:::tip
Misskey Hubは[VuePress](https://github.com/vuepress/vuepress-next)を使ってビルドされた静的サイトです。
Misskey HubはNuxtを使ってビルドされた静的サイトです。
:::
- [更新履歴](../updates.md)
## Misskey Hubに貢献する
ドキュメントの追加や、翻訳など歓迎です。

View File

@ -0,0 +1,2 @@
title: "サーバー運営者向け"
description: "サーバーの作成方法や、運営に際してのお役立ち情報を公開中。"

View File

@ -0,0 +1,2 @@
title: "Misskeyのインストールと保守"
description: "Misskeyのインストール方法や、その後の保守作業に役立つ情報を掲載しています。"

View File

@ -17,18 +17,6 @@ Cloudflare が最新の JavaScript を解釈せず、中のソースコードを
詳しくは [misskey-dev/misskey #9791](https://github.com/misskey-dev/misskey/issues/9791) をご覧ください。
:::
## Docker Composeを使ったインストール
[こちら](./install/docker.html)
## インストール方法一覧
## bashスクリプトを使ったインストール
[こちら](./install/bash.html)
## 全部自力でインストール
[基本編](./install/manual.html)\
[Ubuntu版詳細説明](./install/ubuntu-manual.html)
## YunoHostを使ったインストール
MisskeyはYunoHostでAppとしてインストールできます。詳しくは、[Yunohost向けのMisskeyパッケージのリポジトリ](https://github.com/YunoHost-Apps/misskey_ynh)をご覧ください。
## Kubernetes/TrueNASを使ったインストール
[こちら](./install/kubernetes.html)
<MkIndex />

View File

@ -119,7 +119,7 @@ systemdは、Docker Hubにイメージを上げるまでもないものの、フ
## nginxを使うかどうか
サーバー1台でMisskeyを構築する場合は、nginxの使用をお勧めします。
ロードバランサーを設置する場合にはnginxをインストールせず、[Misskeyのnginx設定](https://misskey-hub.net/docs/admin/nginx.html)を参考にロードバランサーを設定するのがよいと思います。
ロードバランサーを設置する場合にはnginxをインストールせず、[Misskeyのnginx設定](../resources/nginx/)を参考にロードバランサーを設定するのがよいと思います。
## Add more swaps!
スワップを設定している場合、メモリが合計で3GB以上でなければスクリプトが動作しないようになっています。

View File

@ -11,7 +11,7 @@ Docker Composeを使ったMisskey構築
一度使用を始めたサーバーのドメイン・ホスト名は、決して変更しないでください!
:::
:::tip 前提条件
:::tip{label='前提条件'}
- DockerおよびDocker Composeがインストールされていること。
:::

View File

@ -2,7 +2,7 @@
description: 'このガイドではMisskeyのインストール・セットアップ方法について解説します。'
---
Misskey構築の手引き
Misskeyを手動で構築する
================================================================
このガイドではMisskeyのインストール・セットアップ方法について解説します。
@ -11,8 +11,8 @@ Misskey構築の手引き
一度使用を始めたサーバーのドメイン・ホスト名は、決して変更しないでください!
:::
:::tip 前提条件
以下のソフトウェアがインストール・設定されていること
:::tip{label='前提条件'}
#### 以下のソフトウェアがインストール・設定されていること
- **[Node.js](https://nodejs.org/en/)** (20.4.x以上)
- **[PostgreSQL](https://www.postgresql.org/)** (15以上)
- **[Redis](https://redis.io/)**
@ -20,7 +20,7 @@ Misskey構築の手引き
Debian/Ubuntuをお使いであれば、`build-essential`パッケージをインストールしておくと良いです。
corepackが有効化されていること
#### corepackが有効化されていること
```sh
sudo corepack enable
```

View File

@ -2,13 +2,13 @@
## その他のMisskeyインストール方法
- [基本版 Misskey構築の手引き (manual.html)](./manual.html)
- [その他のインストール方法一覧](../install.html)
- [基本版 Misskey構築の手引き (manual)](./manual/)
- [その他のインストール方法一覧](./docs/for-admin/install/)
## シェルスクリプトのお知らせ
コピペばかりならシェルスクリプトでいいじゃん、と言うことで**シェルスクリプトでほぼ全部やってくれるやつを作ってみました!**\
[**シェルスクリプトの詳細と使用方法はこちらから!**](./bash.html)
[**シェルスクリプトの詳細と使用方法はこちらから!**](./bash/)
:::tip
シェルスクリプトでの開発環境へのインストールは想定されていません。
@ -22,9 +22,9 @@
## この記事について
この記事では、[Misskey構築の手引き (manual.html)](./manual.html)で紹介されている通り、systemdでMisskeyを動作させています。
この記事では、[Misskey構築の手引き (manual)](./manual/)で紹介されている通り、systemdでMisskeyを動作させています。
[docker-compose](./docker.html)なら、手作業でももうちょっと簡単に実行できるはずです。
[docker-compose](./docker/)なら、手作業でももうちょっと簡単に実行できるはずです。
:::danger
一度使用を始めたサーバーのドメイン・ホスト名は、決して変更しないでください!
@ -32,7 +32,7 @@
## はじめに
この記事では、[Misskey構築の手引き (manual.html)](./manual.html)を基に、一般的なUbuntuサーバーへMisskeyをインストールし公開する方法の一挙手一投足を解説する。
この記事では、[Misskey構築の手引き (manual)](./manual/)を基に、一般的なUbuntuサーバーへMisskeyをインストールし公開する方法の一挙手一投足を解説する。
Bashのコマンド入力、いくつかの設定ファイルの編集、そしてブラウザの操作だけで設定が完了するようにしている。インストールするソフトウェアについて簡単に説明しているが、気にする必要はない。
@ -73,7 +73,7 @@ nano /path/to/file
Misskeyはrootで実行しない方がよいため、専用のユーザーを作成する。
```
```sh
sudo adduser --disabled-password --disabled-login misskey
```
@ -113,7 +113,7 @@ PostgreSQLは、オブジェクト関係データベース管理システムで
シェルスクリプトを実行し、最新バージョンv15をインストールしよう。
```
```sh
sudo apt install -y postgresql-common
sudo sh /usr/share/postgresql-common/pgdg/apt.postgresql.org.sh -i -v 15;
@ -279,7 +279,7 @@ ufwは、netfilter(iptables)を人間が操作しやすいようにするアプ
CloudFlareは、自分のドメインに対してDNSサーバー・リバースプロキシ・CDNをいっぺんに提供してくれるたいへん便利なサービスである。\
CloudFlareを経由せずにサーバーを公開することも可能だが、たいへん便利なので導入することをお勧めする。
[**→ CDNの設定**](/docs/admin/cdn.html)
[**→ CDNの設定**](/docs/admin/cdn/)
[CloudFlareにサインアップ](https://dash.cloudflare.com/sign-up) し、購入したドメインを案内に従って登録する。
@ -425,7 +425,7 @@ exit
sudo nano /etc/nginx/conf.d/misskey.conf
```
[Misskey Hub](https://misskey-hub.net/docs/admin/nginx.html)の設定例をnanoへコピーペーストし、次の部分を自分のものに書き換える。
[Misskey Hub](https://misskey-hub.net/docs/admin/nginx/)の設定例をnanoへコピーペーストし、次の部分を自分のものに書き換える。
* 18行目と30行目のドメイン名
* 34-35行目の証明書へのパスをCertbotで取得したものに (基本的にexample.tldを置き換えるだけでOK)
@ -534,7 +534,7 @@ sudo nano /etc/systemd/system/misskey.service
次の内容を貼り付け、保存する。
```
```ini
[Unit]
Description=Misskey daemon
@ -584,7 +584,7 @@ Misskeyサーバーに自分のアカウントを登録・ログインし、設
## Misskeyのアップデート
[→ manual.html#Misskeyのアップデート方法](https://misskey-hub.net/docs/install/manual.html#misskey%E3%81%AE%E3%82%A2%E3%83%83%E3%83%95%E3%82%9A%E3%83%86%E3%82%99%E3%83%BC%E3%83%88%E6%96%B9%E6%B3%95)
[Misskeyのアップデート方法](../guides/manual/)
作業中はMisskeyを使うことができません。

View File

@ -0,0 +1,2 @@
title: "Misskeyの保守・トラブルシューティング"
description: "Misskeyサーバーの運営には定期的なメンテナンスが不可欠。役立つ情報や困ったときの対処法をご紹介します。"

View File

@ -5,7 +5,7 @@
MisskeyInstallBattle参加者が増えましたが、それに伴い時期を追うごとに重軽傷者が増加しています。\
この記事ではそのような負傷者を減らすため、過去に事故が起きてしまった個所の傾向と対策をわかりやすく解説します。
**まず最初に、[構築の手引き](/docs/install/manual.html)を熟読してください。**
**まず最初に、[構築の手引き](../guides/manual/)を熟読してください。**
また、拙著の[Ubuntu向けsystemd版解説](https://hide.ac/articles/iFwm5HDvH)、[Oracle Cloud版詳細解説](https://hide.ac/articles/csERs-7SU)も参考までにお読みいただけると幸いです。
@ -22,7 +22,7 @@ Ubuntu向け解説はコピペばかりでつまらない時間がかかる
シェルスクリプトに不具合があれば[製作者(aqz)](https://p1.a9z.dev/@aqz)にお知らせいただければと思います。
# インストールとビルド
[構築の手引き](/docs/install/manual.html)をよく読みましょう。
[構築の手引き](../guides/manual/)をよく読みましょう。
## ImageMagick関連
***ImageMagickは不要です***
@ -32,24 +32,24 @@ Misskeyのビルドには、経験則上、最低でも2GBのメモリが必要
サーバーをスケールアップする手もありますが、お使いのPCでビルドしてサーバーにデプロイするという手もあります。
## なんだかうまくいかない
- [構築の手引き](/docs/install/manual.html)をよく読みましょう。
- [構築の手引き](../guides/manual/)をよく読みましょう。
- node.jsのバージョンが古いかも
* 新しめのバージョンにしましょう。
- インストールやビルドの際にErrorとかWARNとかが出てくることがありますが、問題ない場合もあります。とりあえず`npm start`して動作確認しちゃいましょう。
- node-gypがインストールされていないかも
* `apt install build-essential`を試す。
* Windowsは[この記事](https://qiita.com/AkihiroTakamura/items/25ba516f8ec624e66ee7)も参考にしてみる。
- これでもだめそうだったら、最初から[構築の手引き](/docs/install/manual.html)の手順に従ってやり直してみてください。
- これでもだめそうだったら、最初から[構築の手引き](../guides/manual/)の手順に従ってやり直してみてください。
## バージョンアップ後に不具合が発生した
- [構築の手引き](/docs/install/manual.html)およびリリースノートをよく読みましょう。
- [構築の手引き](../guides/manual/)およびリリースノートをよく読みましょう。
- Misskeyのバージョンアップ時にはしっかり`pnpm install`や`pnpm run migrate`してください。それでも直らない場合、`pnpm run clean-all && pnpm install`を試し、`pnpm run build && pnpm run migrate && pnpm start`してみてください。
- これでもだめそうだったら、最初から[構築の手引き](/docs/install/manual.html)の手順に従ってやり直してみてください。
- これでもだめそうだったら、最初から[構築の手引き](../guides/manual/)の手順に従ってやり直してみてください。
---
# 設定
[構築の手引き](/docs/install/manual.html)をよく読みましょう。
[構築の手引き](../guides/manual/)をよく読みましょう。
`.config/default.yml`で設定を行います。
[`.config/example.yml`](https://github.com/misskey-dev/misskey/blob/develop/.config/example.yml)をコピーし、コメントに従って記述します。
@ -174,7 +174,7 @@ https:
# `npm start`やアクセス時によく遭遇するエラー
`npm start`でサーバーを立てられたものの、その後不具合に遭遇してしまう場合もあります。
まず、[構築の手引き](/docs/install/manual.html)をよく読みましょう。
まず、[構築の手引き](../guides/manual/)をよく読みましょう。
## YAMLのエラーが出る
`default.yml`の構文にミスがある可能性があります。

View File

@ -0,0 +1,2 @@
title: "モデレーション上のお役立ち情報"
description: "実際にサーバーを運営するにあたり役立つ情報についてまとめています。"

View File

@ -0,0 +1,13 @@
---
description: 'MisskeyはAPIを公開しています。APIを使ってMisskeyクライアント、Misskey連携Webサービス、Bot等(以下「アプリケーション」と呼びます)を開発することができます。'
---
# Misskey API
MisskeyはAPIを公開しています。APIを使ってMisskeyクライアント、Misskey連携Webサービス、Bot等(以下「アプリケーション」と呼びます)を開発することができます。
ストリーミングAPIもあるので、リアルタイム性のあるアプリケーションを作ることも可能です。
:::tip
Misskey公式SDKやサードパーティライブラリを使うことによって、このドキュメントで説明するいくつかの手順を簡略化できるなど、より便利にAPIを利用することができます。\
:::
<MkIndex />

View File

@ -0,0 +1,11 @@
---
description: 'アプリケーションが要求する権限の一覧'
---
# 権限の一覧
:::tip
このページは[misskey-js](https://github.com/misskey-dev/misskey/tree/develop/packages/misskey-js)から自動生成しているため、ドキュメントや翻訳が不完全な場合があります。
:::
<ApiPermissions></ApiPermissions>

View File

@ -0,0 +1,113 @@
# アクセストークンの取得
APIを使い始めるには、APIを利用するアカウントに紐づいた**アクセストークン**を取得する必要があります。
このドキュメントでは、アクセストークンを取得する手順を説明した後、基本的なAPIの使い方を説明します。
基本的に、APIはリクエストにはアクセストークンが必要となります。
アクセストークンは、ユーザーに紐づいた認証情報で、APIを利用するユーザーを識別するとともに、アクセストークンごとにどういった操作の権限を持っているかが管理されます。
:::tip
ユーザーとそのユーザーに紐づいたアクセストークンは一対多の関係であり、あるユーザーに対して複数のアクセストークンが発行され得ます。
:::
あなた自分自身のアクセストークンは簡単に取得できるほか、あなたのアプリケーションを使用することになる不特定のユーザーのアクセストークンを取得することもできます。
- 前者の場合: **「自分自身のアクセストークンを手動発行する」** に進む
- 後者の場合: **「アプリケーション利用者にアクセストークンの発行をリクエストする」** に進む
### 自分自身のアクセストークンを手動発行する
Misskey Webの「設定 > API」で、自分のアクセストークンを発行できます。
:::danger
アクセストークンは他人に知られないようにしてください。
:::
### アプリケーション利用者にアクセストークンの発行をリクエストする
アプリケーションを利用するユーザー(以下単に「ユーザー」と呼びます)のアクセストークンを取得するには、以下の手順で発行をリクエストします。
:::tip
以下に説明する方法は、アプリを作成せずインスタントにアクセストークンを発行する、MiAuthと呼ばれるものです。
[アプリ作成方式でのアクセストークン取得方法もあります(旧来型)。](./app)
:::
#### Step 1
UUIDを生成する。以後これを**セッションID**と呼びます。
:::danger
このセッションIDは毎回生成し、使いまわさないようにしてください。
:::
#### Step 2
アプリケーション認証フォームをユーザーのブラウザで表示させる。認証フォームは、以下の形式のURLで開くことができます:
```
https://{host}/miauth/{session}
```
ここで、
- `{host}`の部分は、ユーザーのサーバーのホストに置き換えます。通常ホストはユーザーが入力します。
- `{session}`の部分は、セッションIDに置き換えます。
また、URLにクエリパラメータとしていくつかのオプションを設定できます:
| 名前 | 説明 |
| ------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| `name` | アプリケーション名。 |
| `icon` | アプリケーションのアイコン画像URL。 |
| `callback` | 認証が終わった後にリダイレクトするURL。<br>リダイレクト時には、`session`というクエリパラメータでセッションIDが付きます。 |
| `permission` | アプリケーションが要求する権限。<br>要求する権限を`,`で区切って列挙します。権限の一覧は[こちら](./permission.md)で確認できます。 |
:::tip{label='例'}
```
https://misskey.io/miauth/c1f6d42b-468b-4fd2-8274-e58abdedef6f?name=MyApp&callback=https%3A%2F%2Fmyapp.example.com%2Fcallback&permission=write:notes,write:following,read:drive
```
:::
#### Step 3
ユーザーがアプリケーションアクセスを許可した後、次の形式のURLにPOSTリクエストすると、レスポンスとしてアクセストークンを含むJSONが返ります。
```
https://{host}/api/miauth/{session}/check
```
ここで、
- `{host}`の部分は、ユーザーのサーバーのホストに置き換えます。
- `{session}`の部分は、セッションIDに置き換えます。
レスポンスに含まれるプロパティは以下の通りです:
| 名前 | 説明 |
| ------- | ---------------------------- |
| `token` | ユーザーのアクセストークン。 |
| `user` | ユーザーの情報。 |
## APIの利用
アクセストークンが取得できたら、各種エンドポイントにリクエストすることでAPIの利用が行えます。
:::tip
- HTTP APIはすべてPOSTで、リクエスト/レスポンスともにJSON形式ですdrive/files/createを除く
- 要求ヘッダーに`Content-Type: application/json`を指定します。
- アクセストークンは、`i`というパラメータ名でリクエストボディJSONに含めます。
- ベースURLは`https://{サーバーのドメイン}/api`です。
:::
アクセストークン付きのボディの例metaの場合:
```json
{
"i": "HogEFugA1341",
"detail": false
}
```
APIの詳細は、[APIリファレンス](./endpoints.html)を参照してください。
:::warning
MisskeyはRESTを採用していません。
:::
また、MisskeyはHTTP APIだけでなく、ストリーミングAPIも提供しています。ストリーミングAPIの詳細は[こちらのドキュメント](./streaming/index.md)を参照してください。

View File

@ -1,7 +1,13 @@
# Botの作成
[Misskey API](./api)を利用してBotの開発が可能です。
[Misskey API](/docs/for-developers/api/)を利用してBotの開発が可能です。
また、いくつかのBot実装が公開されているため、ぜひ参考にしてください。
- [syuilo/ai](https://github.com/syuilo/ai) ... Node.js上で動く、TypeScript製Bot実装
Botを作成したときは、プロフィール設定からBotフラグをオンにしておくことを強くおすすめします。
## 関連リソース
- [Misskey API](./api/)
<MkIndex />

View File

@ -0,0 +1,2 @@
title: "プラグイン・Playの作成"
description: "プラグインやPlayを作成する方法・各種リファレンスを公開中。"

View File

@ -6,7 +6,18 @@ Misskey Webクライアントのプラグイン機能を使うと、クライア
プラグインはAiScriptを使って記述されるスクリプトです。
## メタデータ
プラグインは、AiScriptのメタデータ埋め込み機能を使って、デフォルトとしてプラグインのメタデータを定義する必要があります。
プラグインは、AiScriptのメタデータ埋め込み機能を使って、デフォルトとしてプラグインのメタデータを定義する必要があります。メタデータの例は以下の通りです。
```js
/// @ 0.12.4
### {
name: "プラグイン名"
version: "4.2.1"
author: "作者名"
description: "説明文"
}
```
メタデータは次のプロパティを含むオブジェクトです。
### name
@ -43,4 +54,4 @@ string number boolean
## API
Misskey Webはプラグインに対してAPIを公開していて、それらを利用することでクライアントの機能を拡張できます。
どのようなAPIがあるかは[プラグインAPIリファレンス](./plugin-api-reference.md)を参照してください。
どのようなAPIがあるかは[プラグインAPIリファレンス](./plugin-api-reference/)を参照してください。

View File

@ -1,49 +1,49 @@
# プラグインAPIリファレンス
## Mk:dialog(title text type)
## `Mk:dialog(title text type)`
ダイアログを表示します。typeには以下の値が設定できます。\
info success warn error question\
省略すると info になります。
`info` `success` `warn` `error` `question`\
省略すると `info` になります。
## Mk:confirm(title text type)
## `Mk:confirm(title text type)`
確認ダイアログを表示します。typeには以下の値が設定できます。\
info success warn error question\
省略すると question になります。\
ユーザーが"OK"を選択した場合は true を、"キャンセル"を選択した場合は false が返ります。
`info` `success` `warn` `error` `question`\
省略すると `question` になります。\
ユーザーが"OK"を選択した場合は `true` を、"キャンセル"を選択した場合は `false` が返ります。
## Mk:api(endpoint params)
## `Mk:api(endpoint params)`
Misskey APIにリクエストします。第一引数にエンドポイント名、第二引数にパラメータオブジェクトを渡します。
## Mk:save(key value)
## `Mk:save(key value)`
任意の値に任意の名前を付けて永続化します。永続化した値は、AiScriptコンテキストが終了しても残り、Mk:loadで読み取ることができます。
## Mk:load(key)
## `Mk:load(key)`
Mk:saveで永続化した指定の名前の値を読み取ります。
## Plugin:register_post_form_action(title fn)
## `Plugin:register_post_form_action(title fn)`
投稿フォームにアクションを追加します。第一引数にアクション名、第二引数にアクションが選択された際のコールバック関数を渡します。\
コールバック関数には、第一引数に投稿フォームオブジェクトが渡されます。
## Plugin:register_note_action(title fn)
## `Plugin:register_note_action(title fn)`
ノートメニューに項目を追加します。第一引数に項目名、第二引数に項目が選択された際のコールバック関数を渡します。\
コールバック関数には、第一引数に対象のノートオブジェクトが渡されます。
## Plugin:register_user_action(title fn)
## `Plugin:register_user_action(title fn)`
ユーザーメニューに項目を追加します。第一引数に項目名、第二引数に項目が選択された際のコールバック関数を渡します。\
コールバック関数には、第一引数に対象のユーザーオブジェクトが渡されます。
## Plugin:register_note_view_interruptor(fn)
## `Plugin:register_note_view_interruptor(fn)`
UIに表示されるート情報を書き換えます。\
コールバック関数には、第一引数に対象のノートオブジェクトが渡されます。\
コールバック関数の返り値でノートが書き換えられます。
## Plugin:register_note_post_interruptor(fn)
## `Plugin:register_note_post_interruptor(fn)`
ノート投稿時にノート情報を書き換えます。\
コールバック関数には、第一引数に対象のノートオブジェクトが渡されます。\
コールバック関数の返り値でノートが書き換えられます。
## Plugin:open_url(url)
## `Plugin:open_url(url)`
第一引数に渡されたURLをブラウザの新しいタブで開きます。
## Plugin:config
## `Plugin:config`
プラグインの設定が格納されるオブジェクト。プラグイン定義のconfigで設定したキーで値が入ります。

Binary file not shown.

After

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 199 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB