Skip to content

Commit edf27be

Browse files
authored
Merge pull request #38 from WaifuAPI/staging
Staging
2 parents 1e1968c + 65ae539 commit edf27be

Some content is hidden

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

88 files changed

+7307
-149
lines changed

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docs.waifu.it",
3-
"version": "2.0.4",
3+
"version": "3.0.4",
44
"description": "The new and improved documentation for Waifu.it",
55
"scripts": {
66
"dev": "next dev",
@@ -17,7 +17,7 @@
1717
},
1818
"homepage": "https://github.com/WaifuAPI/Documentation/#readme",
1919
"dependencies": {
20-
"next": "^13.4.9",
20+
"next": "^13.4.12",
2121
"nextra": "2.0.1",
2222
"nextra-theme-docs": "2.0.1",
2323
"react": "^18.2.0",

pages/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<br />
44

55
### How do I get the API token?
6-
- To get your API token, join this [discord server](https://discord.gg/yyW389c), then type `-claim` in [#bot-commands](https://discord.com/channels/479300008118714388/800784815908454452), fill the questions asked by [@Kohai](https://discord.com/channels/@me/834416864766591016) in DM, and receive your token.
6+
- To get your API token, join this [discord server](https://discord.gg/yyW389c), then type `-claim` in [#bot-commands](https://discord.com/channels/479300008118714388/800784815908454452), fill the questions asked by `@Kohai` in DM, and receive your token.
77

88
{/* ### CORS causing trouble?
99

pages/libraries/Javascript/_meta.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,9 @@
22
"animefact": {
33
"title": "anime-facts",
44
"theme": { "collapsed": true }
5+
},
6+
"waifuit": {
7+
"title": "waifu.it",
8+
"theme": { "collapsed": true }
59
}
610
}
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"getstarted": "Get Started",
3+
"generatefact": "Generate Fact",
4+
"generatequote": "Generate Quote",
5+
"generatewaifu": "Generate Waifu"
6+
}
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: waifu.it | Generate Fact
3+
---
4+
5+
import { Tab, Tabs } from "nextra-theme-docs";
6+
7+
# Generate Fact
8+
9+
Generate random anime facts from a huge database.
10+
11+
12+
## Functions
13+
14+
| Function | Type | Description | Required? |
15+
| :------: | :------: | ---------------------------------------------------- | :-------: |
16+
| getFact | function | The search function to generate a random anime fact. | Yes |
17+
18+
## Request Samples
19+
20+
<Tabs items={["Node.js"]}>
21+
<Tab>
22+
<>
23+
```js
24+
import Client from "waifu.it";
25+
26+
// Replace <TOKEN> with your API Token
27+
const api = new Client("<TOKEN>");
28+
api.getFact().then((res) => console.log(res));
29+
```
30+
</>
31+
32+
</Tab>
33+
</Tabs>
34+
35+
## Response Schema
36+
37+
<Tabs items={["200 OK"]}>
38+
<Tab>
39+
**Content Type:** `application/json`
40+
```json copy=false
41+
{
42+
"id": 5,
43+
"fact": "TEZUKA Osamu is the most famous manga artist in Japan.",
44+
}
45+
```
46+
</Tab>
47+
</Tabs>
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: waifu.it | Generate Quote
3+
---
4+
5+
import { Tab, Tabs } from "nextra-theme-docs";
6+
7+
# Generate Fact
8+
9+
Generate random anime Quote from a huge database.
10+
11+
12+
## Functions
13+
14+
| Function | Type | Description | Required? |
15+
| :------: | :------: | ---------------------------------------------------- | :-------: |
16+
| getQuote | function | The search function to generate a random anime quote. | Yes |
17+
18+
## Request Samples
19+
20+
<Tabs items={["Node.js"]}>
21+
<Tab>
22+
<>
23+
```js
24+
import Client from "waifu.it";
25+
26+
// Replace <TOKEN> with your API Token
27+
const api = new Client("<TOKEN>");
28+
api.getQuote().then((res) => console.log(res));
29+
```
30+
</>
31+
32+
</Tab>
33+
</Tabs>
34+
35+
## Response Schema
36+
37+
<Tabs items={["200 OK"]}>
38+
<Tab>
39+
**Content Type:** `application/json`
40+
```json copy=false
41+
{
42+
"id": 5,
43+
"quote": "Even children are forced to grow up in the face of pain.",
44+
"author": "Pain",
45+
"anime": "Naruto"
46+
}
47+
```
48+
</Tab>
49+
</Tabs>
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: waifu.it | Generate Waifu
3+
---
4+
5+
import { Tab, Tabs } from "nextra-theme-docs";
6+
7+
# Generate Fact
8+
9+
Generate random anime Waifu from a huge database.
10+
11+
12+
## Functions
13+
14+
| Function | Type | Description | Required? |
15+
| :------: | :------: | ---------------------------------------------------- | :-------: |
16+
| getWaifu | function | The search function to generate a random anime Waifu. | Yes |
17+
18+
## Request Samples
19+
20+
<Tabs items={["Node.js"]}>
21+
<Tab>
22+
<>
23+
```js
24+
import Client from "waifu.it";
25+
26+
// Replace <TOKEN> with your API Token
27+
const api = new Client("<TOKEN>");
28+
api.getWaifu().then((res) => console.log(res));
29+
```
30+
</>
31+
32+
</Tab>
33+
</Tabs>
34+
35+
## Response Schema
36+
37+
<Tabs items={["200 OK"]}>
38+
<Tab>
39+
**Content Type:** `application/json`
40+
```json copy=false
41+
{
42+
"id": 5,
43+
}
44+
```
45+
</Tab>
46+
</Tabs>
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
import { Tab, Tabs } from "nextra-theme-docs";
2+
3+
# Get Started
4+
5+
The "waifu.it" library is the official wrapper for waifu.it! Very small install size.
6+
7+
## Installation
8+
9+
Instructions for installing the library can be found below.
10+
11+
{/* NOTE: do NOT run a formatter for the time being; it breaks the code blocks below. */}
12+
13+
<Tabs items={["npm", "yarn"]}>
14+
<Tab>
15+
```bash
16+
npm i waifu.it
17+
```
18+
View package at [npmjs.com](https://www.npmjs.com/package/waifu.it)
19+
</Tab>
20+
<Tab>
21+
```bash
22+
yarn add waifu.it
23+
```
24+
View package at [yarnpkg.com](https://yarnpkg.com/package/waifu.it)
25+
</Tab>
26+
</Tabs>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
owo WIP
1+
The developer hasn't provided documentation yet. Reach them at -> [Discord](https://discord.gg/yyW389c)

0 commit comments

Comments
 (0)