Skip to content

Commit fa46da3

Browse files
neetneet
committed
📄 ドキュメントを更新
1 parent abfd773 commit fa46da3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+9180
-1380
lines changed

‎docs/assets/js/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/_client_gateway_.gateway.html‎

Lines changed: 808 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/classes/_qiita_.qiita.html‎ renamed to ‎docs/classes/_client_qiita_.qiita.html‎

Lines changed: 702 additions & 567 deletions
Large diffs are not rendered by default.

‎docs/classes/_errors_qiitaerror_.qiitaerror.html‎

Lines changed: 389 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/classes/_errors_qiitanotfounderror_.qiitanotfounderror.html‎

Lines changed: 349 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/classes/_errors_qiitaunauthorizederror_.qiitaunauthorizederror.html‎

Lines changed: 349 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/classes/_errors_qiitaurlresolveerror_.qiitaurlresolveerror.html‎

Lines changed: 349 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/globals.html‎

Lines changed: 83 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,28 @@ <h2>Index</h2>
6868
<section class="tsd-index-section ">
6969
<h3>External modules</h3>
7070
<ul class="tsd-index-list">
71+
<li class="tsd-kind-external-module"><a href="modules/_client_gateway_.html" class="tsd-kind-icon">"client/<wbr>Gateway"</a></li>
72+
<li class="tsd-kind-external-module"><a href="modules/_client_qiita_.html" class="tsd-kind-icon">"client/<wbr>Qiita"</a></li>
73+
<li class="tsd-kind-external-module"><a href="modules/_entities_accesstoken_.html" class="tsd-kind-icon">"entities/<wbr>Access<wbr>Token"</a></li>
74+
<li class="tsd-kind-external-module"><a href="modules/_entities_authenticateduser_.html" class="tsd-kind-icon">"entities/<wbr>Authenticated<wbr>User"</a></li>
75+
<li class="tsd-kind-external-module"><a href="modules/_entities_comment_.html" class="tsd-kind-icon">"entities/<wbr>Comment"</a></li>
76+
<li class="tsd-kind-external-module"><a href="modules/_entities_expandedtemplate_.html" class="tsd-kind-icon">"entities/<wbr>Expanded<wbr>Template"</a></li>
77+
<li class="tsd-kind-external-module"><a href="modules/_entities_group_.html" class="tsd-kind-icon">"entities/<wbr>Group"</a></li>
78+
<li class="tsd-kind-external-module"><a href="modules/_entities_item_.html" class="tsd-kind-icon">"entities/<wbr>Item"</a></li>
79+
<li class="tsd-kind-external-module"><a href="modules/_entities_like_.html" class="tsd-kind-icon">"entities/<wbr>Like"</a></li>
80+
<li class="tsd-kind-external-module"><a href="modules/_entities_project_.html" class="tsd-kind-icon">"entities/<wbr>Project"</a></li>
81+
<li class="tsd-kind-external-module"><a href="modules/_entities_reaction_.html" class="tsd-kind-icon">"entities/<wbr>Reaction"</a></li>
82+
<li class="tsd-kind-external-module"><a href="modules/_entities_tag_.html" class="tsd-kind-icon">"entities/<wbr>Tag"</a></li>
83+
<li class="tsd-kind-external-module"><a href="modules/_entities_tagging_.html" class="tsd-kind-icon">"entities/<wbr>Tagging"</a></li>
84+
<li class="tsd-kind-external-module"><a href="modules/_entities_team_.html" class="tsd-kind-icon">"entities/<wbr>Team"</a></li>
85+
<li class="tsd-kind-external-module"><a href="modules/_entities_teaminvitation_.html" class="tsd-kind-icon">"entities/<wbr>Team<wbr>Invitation"</a></li>
86+
<li class="tsd-kind-external-module"><a href="modules/_entities_template_.html" class="tsd-kind-icon">"entities/<wbr>Template"</a></li>
87+
<li class="tsd-kind-external-module"><a href="modules/_entities_user_.html" class="tsd-kind-icon">"entities/<wbr>User"</a></li>
88+
<li class="tsd-kind-external-module"><a href="modules/_errors_qiitaerror_.html" class="tsd-kind-icon">"errors/<wbr>Qiita<wbr>Error"</a></li>
89+
<li class="tsd-kind-external-module"><a href="modules/_errors_qiitanotfounderror_.html" class="tsd-kind-icon">"errors/<wbr>Qiita<wbr>Not<wbr>Found<wbr>Error"</a></li>
90+
<li class="tsd-kind-external-module"><a href="modules/_errors_qiitaurlresolveerror_.html" class="tsd-kind-icon">"errors/<wbr>QiitaURLResolve<wbr>Error"</a></li>
91+
<li class="tsd-kind-external-module"><a href="modules/_errors_qiitaunauthorizederror_.html" class="tsd-kind-icon">"errors/<wbr>Qiita<wbr>Unauthorized<wbr>Error"</a></li>
7192
<li class="tsd-kind-external-module"><a href="modules/_index_.html" class="tsd-kind-icon">"index"</a></li>
72-
<li class="tsd-kind-external-module"><a href="modules/_qiita_.html" class="tsd-kind-icon">"qiita"</a></li>
7393
</ul>
7494
</section>
7595
</div>
@@ -83,10 +103,70 @@ <h3>External modules</h3>
83103
<a href="globals.html"><em>Globals</em></a>
84104
</li>
85105
<li class=" tsd-kind-external-module">
86-
<a href="modules/_index_.html">"index"</a>
106+
<a href="modules/_client_gateway_.html">"client/<wbr>Gateway"</a>
107+
</li>
108+
<li class=" tsd-kind-external-module">
109+
<a href="modules/_client_qiita_.html">"client/<wbr>Qiita"</a>
110+
</li>
111+
<li class=" tsd-kind-external-module">
112+
<a href="modules/_entities_accesstoken_.html">"entities/<wbr>Access<wbr>Token"</a>
113+
</li>
114+
<li class=" tsd-kind-external-module">
115+
<a href="modules/_entities_authenticateduser_.html">"entities/<wbr>Authenticated<wbr>User"</a>
116+
</li>
117+
<li class=" tsd-kind-external-module">
118+
<a href="modules/_entities_comment_.html">"entities/<wbr>Comment"</a>
119+
</li>
120+
<li class=" tsd-kind-external-module">
121+
<a href="modules/_entities_expandedtemplate_.html">"entities/<wbr>Expanded<wbr>Template"</a>
122+
</li>
123+
<li class=" tsd-kind-external-module">
124+
<a href="modules/_entities_group_.html">"entities/<wbr>Group"</a>
125+
</li>
126+
<li class=" tsd-kind-external-module">
127+
<a href="modules/_entities_item_.html">"entities/<wbr>Item"</a>
128+
</li>
129+
<li class=" tsd-kind-external-module">
130+
<a href="modules/_entities_like_.html">"entities/<wbr>Like"</a>
131+
</li>
132+
<li class=" tsd-kind-external-module">
133+
<a href="modules/_entities_project_.html">"entities/<wbr>Project"</a>
134+
</li>
135+
<li class=" tsd-kind-external-module">
136+
<a href="modules/_entities_reaction_.html">"entities/<wbr>Reaction"</a>
87137
</li>
88138
<li class=" tsd-kind-external-module">
89-
<a href="modules/_qiita_.html">"qiita"</a>
139+
<a href="modules/_entities_tag_.html">"entities/<wbr>Tag"</a>
140+
</li>
141+
<li class=" tsd-kind-external-module">
142+
<a href="modules/_entities_tagging_.html">"entities/<wbr>Tagging"</a>
143+
</li>
144+
<li class=" tsd-kind-external-module">
145+
<a href="modules/_entities_team_.html">"entities/<wbr>Team"</a>
146+
</li>
147+
<li class=" tsd-kind-external-module">
148+
<a href="modules/_entities_teaminvitation_.html">"entities/<wbr>Team<wbr>Invitation"</a>
149+
</li>
150+
<li class=" tsd-kind-external-module">
151+
<a href="modules/_entities_template_.html">"entities/<wbr>Template"</a>
152+
</li>
153+
<li class=" tsd-kind-external-module">
154+
<a href="modules/_entities_user_.html">"entities/<wbr>User"</a>
155+
</li>
156+
<li class=" tsd-kind-external-module">
157+
<a href="modules/_errors_qiitaerror_.html">"errors/<wbr>Qiita<wbr>Error"</a>
158+
</li>
159+
<li class=" tsd-kind-external-module">
160+
<a href="modules/_errors_qiitanotfounderror_.html">"errors/<wbr>Qiita<wbr>Not<wbr>Found<wbr>Error"</a>
161+
</li>
162+
<li class=" tsd-kind-external-module">
163+
<a href="modules/_errors_qiitaurlresolveerror_.html">"errors/<wbr>QiitaURLResolve<wbr>Error"</a>
164+
</li>
165+
<li class=" tsd-kind-external-module">
166+
<a href="modules/_errors_qiitaunauthorizederror_.html">"errors/<wbr>Qiita<wbr>Unauthorized<wbr>Error"</a>
167+
</li>
168+
<li class=" tsd-kind-external-module">
169+
<a href="modules/_index_.html">"index"</a>
90170
</li>
91171
</ul>
92172
</nav>

‎docs/index.html‎

Lines changed: 66 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -67,18 +67,16 @@ <h1 id="qiita-js-2">qiita-js-2</h1>
6767
<h2 id="-">使い方</h2>
6868
<h3 id="qiita-js-2-"><code>qiita-js-2</code>をインストールする</h3>
6969
<p><strong>NPM:</strong></p>
70-
<pre><code>npm <span class="hljs-selector-tag">i</span> qiita-js-<span class="hljs-number">2</span> --save
71-
</code></pre><p><strong>Yarn:</strong></p>
72-
<pre><code>yarn <span class="hljs-keyword">add</span><span class="bash"> qiita-js-2</span>
73-
</code></pre><h3 id="-">トークンを取得</h3>
70+
<pre><code>npm <span class="hljs-selector-tag">i</span> qiita-js-<span class="hljs-number">2</span> --save</code></pre><p><strong>Yarn:</strong></p>
71+
<pre><code>yarn <span class="hljs-keyword">add</span><span class="bash"> qiita-js-2</span></code></pre><h3 id="-">トークンを取得</h3>
7472
<p>Qiitaの<a href="https://qiita.com/settings/applications">アプリケーションページ</a>を開き，新しいアクセストークンを発行します．</p>
7573
<p><img src="https://i.imgur.com/LPtgosR.png" alt="新しいアクセストークンを発行"></p>
7674
<p>アクセストークンを発行します．説明と，必要に応じてスコープを付与し発行してください．</p>
7775
<p><img src="https://i.imgur.com/7yxJWmw.png" alt="アクセストークンの発行"></p>
7876
<p>生成されたアクセストークンをコピーして保存してください．このトークンは以下で必要です</p>
7977
<p><img src="https://i.imgur.com/l6V6qmg.png" alt="アクセストークン"></p>
8078
<h3 id="-">利用する</h3>
81-
<pre><code class="lang-ts"><span class="hljs-comment">// Node.js</span>
79+
<pre><code class="language-ts"><span class="hljs-comment">// Node.js</span>
8280
<span class="hljs-keyword">const</span> Qiita = <span class="hljs-built_in">require</span>(<span class="hljs-string">'qiita-js-2'</span>).default;
8381
<span class="hljs-comment">// TypeScript あるいは Babel</span>
8482
<span class="hljs-keyword">import</span> Qiita <span class="hljs-keyword">from</span> <span class="hljs-string">'qiita-js-2'</span>;
@@ -101,8 +99,7 @@ <h3 id="-">利用する</h3>
10199
<span class="hljs-keyword">private</span>: <span class="hljs-literal">false</span>,
102100
}).then(<span class="hljs-function">(<span class="hljs-params">newItem</span>) =&gt;</span> {
103101
<span class="hljs-built_in">console</span>.log(newItem);
104-
});
105-
</code></pre>
102+
});</code></pre>
106103
<p>利用可能なすべてのメソッドのドキュメントは<a href="https://neet.github.io/qiita-js-2/classes/_qiita_.qiita.html">こちらからご覧いただけます．</a></p>
107104
</div>
108105
</div>
@@ -113,10 +110,70 @@ <h3 id="-">利用する</h3>
113110
<a href="globals.html"><em>Globals</em></a>
114111
</li>
115112
<li class=" tsd-kind-external-module">
116-
<a href="modules/_index_.html">"index"</a>
113+
<a href="modules/_client_gateway_.html">"client/<wbr>Gateway"</a>
114+
</li>
115+
<li class=" tsd-kind-external-module">
116+
<a href="modules/_client_qiita_.html">"client/<wbr>Qiita"</a>
117+
</li>
118+
<li class=" tsd-kind-external-module">
119+
<a href="modules/_entities_accesstoken_.html">"entities/<wbr>Access<wbr>Token"</a>
120+
</li>
121+
<li class=" tsd-kind-external-module">
122+
<a href="modules/_entities_authenticateduser_.html">"entities/<wbr>Authenticated<wbr>User"</a>
123+
</li>
124+
<li class=" tsd-kind-external-module">
125+
<a href="modules/_entities_comment_.html">"entities/<wbr>Comment"</a>
126+
</li>
127+
<li class=" tsd-kind-external-module">
128+
<a href="modules/_entities_expandedtemplate_.html">"entities/<wbr>Expanded<wbr>Template"</a>
129+
</li>
130+
<li class=" tsd-kind-external-module">
131+
<a href="modules/_entities_group_.html">"entities/<wbr>Group"</a>
132+
</li>
133+
<li class=" tsd-kind-external-module">
134+
<a href="modules/_entities_item_.html">"entities/<wbr>Item"</a>
135+
</li>
136+
<li class=" tsd-kind-external-module">
137+
<a href="modules/_entities_like_.html">"entities/<wbr>Like"</a>
138+
</li>
139+
<li class=" tsd-kind-external-module">
140+
<a href="modules/_entities_project_.html">"entities/<wbr>Project"</a>
141+
</li>
142+
<li class=" tsd-kind-external-module">
143+
<a href="modules/_entities_reaction_.html">"entities/<wbr>Reaction"</a>
117144
</li>
118145
<li class=" tsd-kind-external-module">
119-
<a href="modules/_qiita_.html">"qiita"</a>
146+
<a href="modules/_entities_tag_.html">"entities/<wbr>Tag"</a>
147+
</li>
148+
<li class=" tsd-kind-external-module">
149+
<a href="modules/_entities_tagging_.html">"entities/<wbr>Tagging"</a>
150+
</li>
151+
<li class=" tsd-kind-external-module">
152+
<a href="modules/_entities_team_.html">"entities/<wbr>Team"</a>
153+
</li>
154+
<li class=" tsd-kind-external-module">
155+
<a href="modules/_entities_teaminvitation_.html">"entities/<wbr>Team<wbr>Invitation"</a>
156+
</li>
157+
<li class=" tsd-kind-external-module">
158+
<a href="modules/_entities_template_.html">"entities/<wbr>Template"</a>
159+
</li>
160+
<li class=" tsd-kind-external-module">
161+
<a href="modules/_entities_user_.html">"entities/<wbr>User"</a>
162+
</li>
163+
<li class=" tsd-kind-external-module">
164+
<a href="modules/_errors_qiitaerror_.html">"errors/<wbr>Qiita<wbr>Error"</a>
165+
</li>
166+
<li class=" tsd-kind-external-module">
167+
<a href="modules/_errors_qiitanotfounderror_.html">"errors/<wbr>Qiita<wbr>Not<wbr>Found<wbr>Error"</a>
168+
</li>
169+
<li class=" tsd-kind-external-module">
170+
<a href="modules/_errors_qiitaurlresolveerror_.html">"errors/<wbr>QiitaURLResolve<wbr>Error"</a>
171+
</li>
172+
<li class=" tsd-kind-external-module">
173+
<a href="modules/_errors_qiitaunauthorizederror_.html">"errors/<wbr>Qiita<wbr>Unauthorized<wbr>Error"</a>
174+
</li>
175+
<li class=" tsd-kind-external-module">
176+
<a href="modules/_index_.html">"index"</a>
120177
</li>
121178
</ul>
122179
</nav>

0 commit comments

Comments
 (0)