Skip to content

Commit 6bb8a3c

Browse files
authored
Merge pull request #32 from WaifuAPI/staging
Some updated from the staging
2 parents 360757f + 8b6c6e8 commit 6bb8a3c

File tree

26 files changed

+169
-22
lines changed

26 files changed

+169
-22
lines changed

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docs.waifu.it",
3-
"version": "2.0.1",
3+
"version": "2.0.2",
44
"description": "The new and improved documentation for Waifu.it",
55
"scripts": {
66
"dev": "next dev",
@@ -9,13 +9,13 @@
99
},
1010
"repository": {
1111
"type": "git",
12-
"url": "git+https://github.com/WaifuAPI/docs.waifu.it.git"
12+
"url": "git+https://github.com/WaifuAPI/Documentation.git"
1313
},
1414
"license": "MIT",
1515
"bugs": {
16-
"url": "https://github.com/WaifuAPI/docs.waifu.it/issues"
16+
"url": "https://github.com/WaifuAPI/Documentation/issues"
1717
},
18-
"homepage": "https://github.com/WaifuAPI/docs.waifu.it/#readme",
18+
"homepage": "https://github.com/WaifuAPI/Documentation/#readme",
1919
"dependencies": {
2020
"next": "^13.0.6",
2121
"nextra": "2.0.1",

pages/_meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"license": {
88
"title": "License 📝",
99
"type": "page",
10-
"href": "https://raw.githubusercontent.com/WaifuAPI/docs.waifu.it/master/LICENSE",
10+
"href": "https://raw.githubusercontent.com/WaifuAPI/Waifu.it/production/LICENCE.md",
1111
"newWindow": true
1212
},
1313
"contact": {
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"animefact": {
3-
"title": "anime-fact",
3+
"title": "anime-facts",
44
"theme": { "collapsed": true }
55
}
66
}
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2-
"search": "Search"
2+
"getstarted": "Get Started",
3+
"generatefact": "Generate Fact"
34
}
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: anime-facts | 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 AnimeFact from "anime-facts";
25+
26+
// Replace <TOKEN> with your API Token
27+
const api = new AnimeFact("<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: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
import { Tab, Tabs } from "nextra-theme-docs";
2+
3+
# Get Started
4+
5+
The "anime-facts" library, is for the `api/facts` endpoint which only serves with that endpoint. It is maintained by the developers
6+
of the Waifu.it API.
7+
8+
## Installation
9+
10+
Instructions for installing the library can be found below.
11+
12+
{/* NOTE: do NOT run a formatter for the time being; it breaks the code blocks below. */}
13+
14+
<Tabs items={["npm", "yarn"]}>
15+
<Tab>
16+
```bash
17+
npm i anime-facts
18+
```
19+
View package at [npmjs.com](https://www.npmjs.com/package/anime-facts)
20+
</Tab>
21+
<Tab>
22+
```bash
23+
yarn add anime-facts
24+
```
25+
View package at [yarnpkg.com](https://yarnpkg.com/package/anime-facts)
26+
</Tab>
27+
</Tabs>

pages/libraries/start.mdx

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1+
import { Tab, Tabs } from "nextra-theme-docs";
12

23
# Get Started
3-
ok i will write
4+
5+
[Waifu.it](https://waifu.it) community has also made many awesome libraries for the api. Everything that is made by the community and the developer team are featured in
6+
categories of each programming languages.
7+
8+
9+
## Installation
10+
11+
Instructions for installing the library can be found below.
412

pages/list-of-endpoints.mdx

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,25 @@ Waifu.it supports a wealth of endpoints, which can be categorized into the follo
44

55
## Actions
66

7-
[Angry:](http://localhost:3000/rest-api/Actions/Angry/search) This endpoint returns a random anime GIF with the angry reaction.
7+
[Angry:](https://docs.waifu.it/rest-api/Actions/Angry/search) This endpoint returns a random anime GIF with the angry reaction.
88

9-
[Baka:](https://example.com) This endpoint returns a random anime GIF with the baka or idiot reaction.
9+
[Baka:](https://docs.waifu.it/rest-api/Actions/Baka/search) This endpoint returns a random anime GIF with the baka or idiot reaction.
1010

1111

1212
## Emotes
1313

14-
[Blush:](https://example.com) This endpoint returns a random anime GIF with Blush.
14+
[Blush:](https://docs.waifu.it/rest-api/Emotes/Blush/search) This endpoint returns a random anime GIF with Blush.
1515

16+
## Images
17+
18+
[Waifu:](https://docs.waifu.it/rest-api/Images/Waifu/search) Serves with a random anime waifu image with some of it's information.
1619

1720
## Texts
1821

19-
[Fact:](https://example.com) Serves with a random anime fact.
22+
[Fact:](https://docs.waifu.it/rest-api/Texts/Fact/search) Serves with a random anime fact.
23+
24+
[Password:](https://docs.waifu.it/rest-api/Texts/Password/search) Generate's a random `base64` string.
25+
26+
[Quote:](https://docs.waifu.it/rest-api/Texts/Quote/search) Serves with a random anime quote.
27+
28+
[Tags:](https://docs.waifu.it/rest-api/Texts/Tags/search) Response with the available tags for query in certain endpoints.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"search": "Search"
3+
}
File renamed without changes.

0 commit comments

Comments
 (0)