-
-
Notifications
You must be signed in to change notification settings - Fork 157
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: localize root docs and add missing files
- Loading branch information
jdh5968
committed
Jan 6, 2023
1 parent
0a891d6
commit 742fcda
Showing
31 changed files
with
1,000 additions
and
176 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,21 @@ | ||
# Set up a CDN | ||
|
||
When publishing your Misskey instance, we strongly recommend using a CDN such as [Cloudflare](https://www.cloudflare.com/). | ||
|
||
Using a CDN has the following advantages | ||
|
||
- You can have static content cached, which reduces the load on your server | ||
- The IP address of the server is less exposed, which can mitigate DoS attacks etc. | ||
|
||
## Caching | ||
|
||
Misskey Web is completely static and does not require a server to run. Therefore the whole Misskey Web can be cached in a CDN. | ||
The Misskey API cannot be cached. | ||
|
||
You need to configure the following settings in your CDN | ||
|
||
- Cache all requests except `/api/*`. | ||
|
||
::: tip | ||
::: 팁 | ||
You don't need to clear the cache when you update Misskey. | ||
:::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# AiScript | ||
AiScriptは、Misskeyで使用できるスクリプト言語です。 | ||
|
||
<div class="info">ℹ️ AiScript実装はMisskeyとは別リポジトリで、<a href="https://github.com/syuilo/aiscript" target="_blank">オープンソースで公開されています。</a></div> | ||
|
||
## 使い方 | ||
AiScriptの構文や組み込み関数などのドキュメントは、[こちら](https://github.com/syuilo/aiscript/tree/master/docs)で公開されています。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# プラグインの作成 | ||
Misskey Webクライアントのプラグイン機能を使うと、クライアントを拡張し、様々な機能を追加できます。 | ||
このドキュメントではプラグインの作成方法について説明します。 | ||
|
||
## AiScript | ||
プラグインはAiScriptを使って記述されるスクリプトです。 | ||
|
||
## メタデータ | ||
プラグインは、AiScriptのメタデータ埋め込み機能を使って、デフォルトとしてプラグインのメタデータを定義する必要があります。 | ||
メタデータは次のプロパティを含むオブジェクトです。 | ||
|
||
### name | ||
プラグイン名 | ||
|
||
### author | ||
プラグイン作者 | ||
|
||
### version | ||
プラグインバージョン。数値を指定してください。 | ||
|
||
### description | ||
プラグインの説明 | ||
|
||
### permissions | ||
プラグインが要求する権限。MisskeyAPIにリクエストする際に用いられます。 | ||
|
||
### config | ||
プラグインの設定情報を表すオブジェクト。 | ||
キーに設定名、値に以下のプロパティを含めます。 | ||
|
||
#### type | ||
設定値の種類を表す文字列。以下から選択します。 | ||
string number boolean | ||
|
||
#### label | ||
ユーザーに表示する設定名 | ||
|
||
#### description | ||
設定の説明 | ||
|
||
#### default | ||
設定のデフォルト値 | ||
|
||
## API | ||
Misskey Webはプラグインに対してAPIを公開していて、それらを利用することでクライアントの機能を拡張できます。 | ||
どのようなAPIがあるかは[プラグインAPIリファレンス](./plugin-api-reference.md)を参照してください。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# Botの作成 | ||
[Misskey API](./api)を利用してBotの開発が可能です。 | ||
また、いくつかのBot実装が公開されているため、ぜひ参考にしてください。 | ||
|
||
- [syuilo/ai](https://github.com/syuilo/ai) ... Node.js上で動く、TypeScript製Bot実装 | ||
|
||
Botを作成したときは、プロフィール設定からBotフラグをオンにしておくことを強くおすすめします。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# プラグインAPIリファレンス | ||
|
||
## Mk:dialog(title text type) | ||
ダイアログを表示します。typeには以下の値が設定できます。\ | ||
info success warn error question\ | ||
省略すると info になります。 | ||
|
||
## Mk:confirm(title text type) | ||
確認ダイアログを表示します。typeには以下の値が設定できます。\ | ||
info success warn error question\ | ||
省略すると question になります。\ | ||
ユーザーが"OK"を選択した場合は true を、"キャンセル"を選択した場合は false が返ります。 | ||
|
||
## Mk:api(endpoint params) | ||
Misskey APIにリクエストします。第一引数にエンドポイント名、第二引数にパラメータオブジェクトを渡します。 | ||
|
||
## Mk:save(key value) | ||
任意の値に任意の名前を付けて永続化します。永続化した値は、AiScriptコンテキストが終了しても残り、Mk:loadで読み取ることができます。 | ||
|
||
## Mk:load(key) | ||
Mk:saveで永続化した指定の名前の値を読み取ります。 | ||
|
||
## Plugin:register_post_form_action(title fn) | ||
投稿フォームにアクションを追加します。第一引数にアクション名、第二引数にアクションが選択された際のコールバック関数を渡します。\ | ||
コールバック関数には、第一引数に投稿フォームオブジェクトが渡されます。 | ||
|
||
## Plugin:register_note_action(title fn) | ||
ノートメニューに項目を追加します。第一引数に項目名、第二引数に項目が選択された際のコールバック関数を渡します。\ | ||
コールバック関数には、第一引数に対象のノートオブジェクトが渡されます。 | ||
|
||
## Plugin:register_user_action(title fn) | ||
ユーザーメニューに項目を追加します。第一引数に項目名、第二引数に項目が選択された際のコールバック関数を渡します。\ | ||
コールバック関数には、第一引数に対象のユーザーオブジェクトが渡されます。 | ||
|
||
## Plugin:register_note_view_interruptor(fn) | ||
UIに表示されるノート情報を書き換えます。\ | ||
コールバック関数には、第一引数に対象のノートオブジェクトが渡されます。\ | ||
コールバック関数の返り値でノートが書き換えられます。 | ||
|
||
## Plugin:register_note_post_interruptor(fn) | ||
ノート投稿時にノート情報を書き換えます。\ | ||
コールバック関数には、第一引数に対象のノートオブジェクトが渡されます。\ | ||
コールバック関数の返り値でノートが書き換えられます。 | ||
|
||
## Plugin:open_url(url) | ||
第一引数に渡されたURLをブラウザの新しいタブで開きます。 | ||
|
||
## Plugin:config | ||
プラグインの設定が格納されるオブジェクト。プラグイン定義のconfigで設定したキーで値が入ります。 |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.