From 55cb58e4515247cf35691cf89c103cc209a4d8f5 Mon Sep 17 00:00:00 2001 From: syuilo Date: Wed, 24 May 2017 20:09:12 +0900 Subject: [PATCH] WIP #13 --- ...getting-started.pug => getting-started.md} | 45 ++++++++----------- src/docs/api/library.md | 8 ++++ src/docs/api/library.pug | 14 ------ src/docs/index.md | 4 ++ src/docs/index.pug | 9 ---- src/docs/link-to-twitter.md | 9 ++++ src/docs/link-to-twitter.pug | 14 ------ src/docs/privacy.pug | 10 ----- src/docs/tou.md | 4 ++ src/docs/tou.pug | 9 ---- 10 files changed, 43 insertions(+), 83 deletions(-) rename src/docs/api/{getting-started.pug => getting-started.md} (70%) create mode 100644 src/docs/api/library.md delete mode 100644 src/docs/api/library.pug create mode 100644 src/docs/index.md delete mode 100644 src/docs/index.pug create mode 100644 src/docs/link-to-twitter.md delete mode 100644 src/docs/link-to-twitter.pug delete mode 100644 src/docs/privacy.pug create mode 100644 src/docs/tou.md delete mode 100644 src/docs/tou.pug diff --git a/src/docs/api/getting-started.pug b/src/docs/api/getting-started.md similarity index 70% rename from src/docs/api/getting-started.pug rename to src/docs/api/getting-started.md index 2aa2822e42..e13659914e 100644 --- a/src/docs/api/getting-started.pug +++ b/src/docs/api/getting-started.md @@ -1,34 +1,25 @@ -extend ../BASE +Getting Started +================================================================ +MisskeyはREST APIやStreaming APIを提供しており、プログラムからMisskeyの全ての機能を利用することができます。 +それらのAPIを利用するには、まずAPIを利用したいアカウントのアクセストークンを取得する必要があります: -block title - | Getting Started +自分のアクセストークンを取得したい場合 +---------------------------------------------------------------- +自分自身のアクセストークンは、設定 > API で確認できます。 +

+ アカウントを乗っ取られてしまう可能性があるため、トークンは第三者に教えないでください(アプリなどにも入力しないでください)。
+ 万が一トークンが漏れたりその可能性がある場合は トークンを再生成できます。(副作用として、ログインしているすべてのデバイスでログアウトが発生します) +

-block content - h1 Getting Started +他人のアクセストークンを取得する +---------------------------------------------------------------- +不特定多数のユーザーからAPIを利用したい場合、アプリケーションを作成します。 +アプリケーションを作成すると、ユーザーが連携を許可した時に、そのユーザーのアクセストークンを取得することができます。 - p MisskeyはREST APIやStreaming APIを提供しており、プログラムからMisskeyの全ての機能を利用することができます。 - p それらのAPIを利用するには、まずAPIを利用したいアカウントのアクセストークンを取得する必要があります: +アプリケーションを作成してアクセストークンを取得するまでの流れを説明します。 - section - h2 自分のアクセストークンを取得したい場合 - p 自分自身のアクセストークンは、設定 > API で確認できます。 - p.tip - | アカウントを乗っ取られてしまう可能性があるため、トークンは第三者に教えないでください(アプリなどにも入力しないでください)。 - br - | 万が一トークンが漏れたりその可能性がある場合は トークンを再生成できます。(副作用として、ログインしているすべてのデバイスでログアウトが発生します) - - section - h2 他人のアクセストークンを取得する - p - | 不特定多数のユーザーからAPIを利用したい場合、アプリケーションを作成します。 - br - | アプリケーションを作成すると、ユーザーが連携を許可した時に、そのユーザーのアクセストークンを取得することができます。 - p アプリケーションを作成しアクセストークンを取得するまでの流れを見ていきます。 - - section - h3 アプリケーションを作成する - p まずはあなたのアプリケーションを作成しましょう。 - p +### アプリケーションを作成する +まずはあなたのアプリケーションを作成しましょう。 | デベロッパーセンターにアクセスし、アプリ > アプリ作成 に進みます。 br | 次に、フォームに必要事項を記入します: diff --git a/src/docs/api/library.md b/src/docs/api/library.md new file mode 100644 index 0000000000..71ddbe345d --- /dev/null +++ b/src/docs/api/library.md @@ -0,0 +1,8 @@ +ライブラリ +================================================================ + +Misskey APIを便利に利用するためのライブラリ一覧です。 + +.NET +---------------------------------------------------------------- +* **[Misq (公式)](https://github.com/syuilo/Misq)** diff --git a/src/docs/api/library.pug b/src/docs/api/library.pug deleted file mode 100644 index 4b2943b2a9..0000000000 --- a/src/docs/api/library.pug +++ /dev/null @@ -1,14 +0,0 @@ -extend ../BASE - -block title - | ライブラリ - -block content - h1 ライブラリ - - p Misskey APIを便利に利用するためのライブラリ一覧です。 - - section - h2 .NET - ul - li: strong: a(href='https://github.com/syuilo/Misq') Misq (公式) diff --git a/src/docs/index.md b/src/docs/index.md new file mode 100644 index 0000000000..0846cf27e8 --- /dev/null +++ b/src/docs/index.md @@ -0,0 +1,4 @@ +Misskeyについて +================================================================ + +誰か書いて diff --git a/src/docs/index.pug b/src/docs/index.pug deleted file mode 100644 index bae22d9c7f..0000000000 --- a/src/docs/index.pug +++ /dev/null @@ -1,9 +0,0 @@ -extend ./BASE - -block title - | About Misskey - -block content - h1 About Misskey - - p 誰か書いて diff --git a/src/docs/link-to-twitter.md b/src/docs/link-to-twitter.md new file mode 100644 index 0000000000..77fb744576 --- /dev/null +++ b/src/docs/link-to-twitter.md @@ -0,0 +1,9 @@ +Twitterと連携する +================================================================ + +設定 -> Twitter から、お使いのMisskeyアカウントとお使いのTwitterアカウントを関連付けることができます。 +アカウントの関連付けを行うと、プロフィールにTwitterアカウントへのリンクが表示されたりなどします。 + +MisskeyがあなたのTwitterアカウントでツイートしたり誰かをフォローしたりといったことは、 +一切行いませんのでご安心ください。(Misskeyはそのような権限を取得しないので、行おうと思っても行えません) +Twitterのアプリケーション認証フォームでこの権限の詳細を確認することができます。また、いつでも連携を取り消すことができます。 diff --git a/src/docs/link-to-twitter.pug b/src/docs/link-to-twitter.pug deleted file mode 100644 index 6e98df52c3..0000000000 --- a/src/docs/link-to-twitter.pug +++ /dev/null @@ -1,14 +0,0 @@ -extend ./BASE - -block title - | Twitterと連携する - -block content - h1 Twitterと連携する - - p 設定 -> Twitter から、お使いのMisskeyアカウントとお使いのTwitterアカウントを関連付けることができます。 - p アカウントの関連付けを行うと、プロフィールにTwitterアカウントへのリンクが表示されたりなどします。 - p - | MisskeyがあなたのTwitterアカウントでツイートしたり誰かをフォローしたりなどといったことは一切行いませんので、ご安心ください。(Misskeyはそのような権限を取得しないので、行おうと思っても行えません) - br - | このことに関しては、Twitterのアプリケーション認証フォームで詳細を確認することができます。また、いつでも連携を取り消すことができます。 diff --git a/src/docs/privacy.pug b/src/docs/privacy.pug deleted file mode 100644 index 75885c2b0f..0000000000 --- a/src/docs/privacy.pug +++ /dev/null @@ -1,10 +0,0 @@ -extend ./BASE - -block title - | プライバシーポリシー - -block content - h1 プライバシーポリシー - - p Misskeyはユーザーの了解を得た上でメールアドレスを設定することがありますが、この情報をみだりに公開することはありません。ただし、法的強制力のある請求の場合はこの限りではありません。 - p プライバシーポリシーは予告なく変更される可能性があります。 diff --git a/src/docs/tou.md b/src/docs/tou.md new file mode 100644 index 0000000000..fbf87867b4 --- /dev/null +++ b/src/docs/tou.md @@ -0,0 +1,4 @@ +利用規約 +================================================================ + +公序良俗に反する行為はおやめください。 diff --git a/src/docs/tou.pug b/src/docs/tou.pug deleted file mode 100644 index cb3ab84a48..0000000000 --- a/src/docs/tou.pug +++ /dev/null @@ -1,9 +0,0 @@ -extend ./BASE - -block title - | 利用規約 - -block content - h1 利用規約 - - p 法律上問題のあることはお止めください。