Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: APIドキュメントへのリンクを追加 #16

Merged
merged 2 commits into from
Apr 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This is NOT a fork of [@ibaraki-douji/pixivts](https://www.npmjs.com/package/@ib

## 🚀 Install

This library is available at npm: [@book000/pixivts](https://www.npmjs.com/package/@book000/pixivts)

If you are using npm:

```shell
Expand All @@ -24,6 +26,11 @@ yarn add @book000/pixivts
- All API request methods return an [axios](https://www.npmjs.com/package/axios) response.
This allows this library users to use all responses, without having to wait for library updates if the API response changes.

## 📚 API Document

The API documentation for this library is hosted on GitHub Pages and can be found [here](https://book000.github.io/pixivts/).
Please note that many of the comments in the document are written in Japanese!

## 📑 License

This project is licensed under the [MIT License](LICENSE).
5 changes: 4 additions & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<h2>@book000/pixivts</h2></div>
<div class="tsd-panel tsd-typography"><a id="md:pixivts" class="tsd-anchor"></a><h1><a href="#$pixivts" style="color:inherit;text-decoration:none">pixivts</a></h1><p><a href="https://www.pixiv.net/">pixiv</a> Unofficial API Library for TypeScript</p>
<p>This is NOT a fork of <a href="https://www.npmjs.com/package/@ibaraki-douji/pixivts">@ibaraki-douji/pixivts</a>. However, I do use it as a reference.</p>
<a id="md:🚀-install" class="tsd-anchor"></a><h2><a href="#$🚀-install" style="color:inherit;text-decoration:none">🚀 Install</a></h2><p>If you are using npm:</p>
<a id="md:🚀-install" class="tsd-anchor"></a><h2><a href="#$🚀-install" style="color:inherit;text-decoration:none">🚀 Install</a></h2><p>This library is available at npm: <a href="https://www.npmjs.com/package/@book000/pixivts">@book000/pixivts</a></p>
<p>If you are using npm:</p>
<pre><code class="language-shell"><span class="hl-0">npm </span><span class="hl-1">install</span><span class="hl-0"> </span><span class="hl-1">@book000/pixivts</span>
</code></pre>
<p>or if you are using yarn:</p>
Expand All @@ -25,6 +26,7 @@ <h2>@book000/pixivts</h2></div>
<li>All API request methods return an <a href="https://www.npmjs.com/package/axios">axios</a> response.
This allows this library users to use all responses, without having to wait for library updates if the API response changes.</li>
</ul>
<a id="md:📚-api-document" class="tsd-anchor"></a><h2><a href="#$📚-api-document" style="color:inherit;text-decoration:none">📚 API Document</a></h2><p>The API documentation for this library is hosted on GitHub Pages and can be found <a href="https://book000.github.io/pixivts/">here</a>.<br>Please note that many of the comments in the document are written in Japanese!</p>
<a id="md:📑-license" class="tsd-anchor"></a><h2><a href="#$📑-license" style="color:inherit;text-decoration:none">📑 License</a></h2><p>This project is licensed under the <a href="LICENSE">MIT License</a>.</p>
</div></div>
<div class="col-sidebar">
Expand Down Expand Up @@ -53,6 +55,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
<ul>
<li><a href="#md:🚀-install"><span>🚀 <wbr/>Install</span></a></li>
<li><a href="#md:✨-features"><span>✨ <wbr/>Features</span></a></li>
<li><a href="#md:📚-api-document"><span>📚 API <wbr/>Document</span></a></li>
<li><a href="#md:📑-license"><span>📑 <wbr/>License</span></a></li></ul></li></ul></li></ul></div></details></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4-path"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)" id="icon-4-text"></path></svg><span>@book000/pixivts</span></a>
Expand Down