Added docs for node library and some endpoints

a3ryk · a3ryk · commit 1d1c5052d6ac · 2023-05-26T17:31:17.000+05:30
diff --git a/pages/libraries/Javascript/_meta.json b/pages/libraries/Javascript/_meta.json
@@ -1,6 +1,6 @@
 {
   "animefact": {
-    "title": "anime-fact",
+    "title": "anime-facts",
     "theme": { "collapsed": true }
   }
 }
diff --git a/pages/libraries/Javascript/animefact/_meta.json b/pages/libraries/Javascript/animefact/_meta.json
@@ -1,3 +1,4 @@
 {
-  "search": "Search"
+  "getstarted": "Get Started",
+  "generatefact": "Generate Fact"
 }
diff --git a/pages/libraries/Javascript/animefact/generatefact.mdx b/pages/libraries/Javascript/animefact/generatefact.mdx
@@ -0,0 +1,47 @@
+---
+title: anime-facts | Generate Fact
+---
+
+import { Tab, Tabs } from "nextra-theme-docs";
+
+# Generate Fact
+
+Generate random anime facts from a huge database.
+
+
+## Functions
+
+| Function |   Type   | Description                                          | Required? |
+| :------: | :------: | ---------------------------------------------------- | :-------: |
+| getFact  | function | The search function to generate a random anime fact. |    Yes    |
+
+## Request Samples
+
+<Tabs items={["Node.js"]}>
+  <Tab>
+    <>
+        ```js
+        import AnimeFact from "anime-facts";
+
+        // Replace <TOKEN> with your API Token
+        const api = new AnimeFact("<TOKEN>");
+        api.getFact().then((res) => console.log(res));
+        ```
+    </>
+
+  </Tab>
+</Tabs>
+
+## Response Schema
+
+<Tabs items={["200 OK"]}>
+  <Tab>
+  **Content Type:** `application/json`
+  ```json copy=false
+{
+  "id": 5,
+  "fact": "TEZUKA Osamu is the most famous manga artist in Japan.",
+}
+  ```
+  </Tab>
+</Tabs>
diff --git a/pages/libraries/Javascript/animefact/getstarted.mdx b/pages/libraries/Javascript/animefact/getstarted.mdx
@@ -0,0 +1,27 @@
+import { Tab, Tabs } from "nextra-theme-docs";
+
+# Get Started
+
+The "anime-facts" library, is for the `api/facts` endpoint which only serves with that endpoint. It is maintained by the developers
+of the Waifu.it API.
+
+## Installation
+
+Instructions for installing the library can be found below.
+
+{/* NOTE: do NOT run a formatter for the time being; it breaks the code blocks below. */}
+
+<Tabs items={["npm", "yarn"]}>
+  <Tab>
+  ```bash
+  npm i anime-facts
+  ```
+  View package at [npmjs.com](https://www.npmjs.com/package/anime-facts)
+  </Tab>
+  <Tab>
+  ```bash
+  yarn add anime-facts
+  ```
+  View package at [yarnpkg.com](https://yarnpkg.com/package/anime-facts)
+  </Tab>
+</Tabs>
diff --git a/pages/libraries/start.mdx b/pages/libraries/start.mdx
@@ -1,4 +1,12 @@
+import { Tab, Tabs } from "nextra-theme-docs";
 
 # Get Started
- ok  i will write
+
+[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
+categories of each programming languages.
+
+
+## Installation
+
+Instructions for installing the library can be found below.
 
diff --git a/pages/rest-api/Emotes/Blush/_meta.json b/pages/rest-api/Emotes/Blush/_meta.json
@@ -0,0 +1,3 @@
+{
+  "search": "Search"
+}
diff --git a/pages/rest-api/Emotes/Blush/search.mdx b/pages/rest-api/Emotes/Blush/search.mdx
diff --git a/pages/rest-api/Emotes/_meta.json b/pages/rest-api/Emotes/_meta.json
@@ -0,0 +1,6 @@
+{
+  "Blush": {
+    "title": "Blush",
+    "theme": { "collapsed": true }
+  }
+}
diff --git a/pages/rest-api/Images/Waifu/_meta.json b/pages/rest-api/Images/Waifu/_meta.json
@@ -0,0 +1,3 @@
+{
+  "search": "Search"
+}
diff --git a/pages/rest-api/Images/Waifu/search.mdx b/pages/rest-api/Images/Waifu/search.mdx
@@ -0,0 +1 @@
+owo WIP
diff --git a/pages/rest-api/Images/_meta.json b/pages/rest-api/Images/_meta.json
@@ -0,0 +1,6 @@
+{
+  "Waifu": {
+    "title": "Waifu",
+    "theme": { "collapsed": true }
+  }
+}
diff --git a/pages/rest-api/Texts/Fact/_meta.json b/pages/rest-api/Texts/Fact/_meta.json
@@ -0,0 +1,3 @@
+{
+  "search": "Search"
+}
diff --git a/pages/rest-api/Texts/Fact/search.mdx b/pages/rest-api/Texts/Fact/search.mdx
@@ -0,0 +1 @@
+owo WIP
diff --git a/pages/rest-api/Texts/Password/_meta.json b/pages/rest-api/Texts/Password/_meta.json
@@ -0,0 +1,3 @@
+{
+  "search": "Search"
+}
diff --git a/pages/rest-api/Texts/Password/search.mdx b/pages/rest-api/Texts/Password/search.mdx
@@ -0,0 +1 @@
+owo WIP
diff --git a/pages/rest-api/Texts/Quote/_meta.json b/pages/rest-api/Texts/Quote/_meta.json
@@ -0,0 +1,3 @@
+{
+  "search": "Search"
+}
diff --git a/pages/rest-api/Texts/Quote/search.mdx b/pages/rest-api/Texts/Quote/search.mdx
@@ -0,0 +1 @@
+owo WIP
diff --git a/pages/rest-api/Texts/Tags/_meta.json b/pages/rest-api/Texts/Tags/_meta.json
@@ -0,0 +1,3 @@
+{
+  "search": "Search"
+}
diff --git a/pages/rest-api/Texts/Tags/search.mdx b/pages/rest-api/Texts/Tags/search.mdx
@@ -0,0 +1 @@
+owo WIP
diff --git a/pages/rest-api/Texts/_meta.json b/pages/rest-api/Texts/_meta.json
@@ -0,0 +1,18 @@
+{
+  "Fact": {
+    "title": "Fact",
+    "theme": { "collapsed": true }
+  },
+  "Password": {
+    "title": "Password",
+    "theme": { "collapsed": true }
+  },
+  "Quote": {
+    "title": "Quote",
+    "theme": { "collapsed": true }
+  },
+  "Tags": {
+    "title": "Tags",
+    "theme": { "collapsed": true }
+  }
+}
diff --git a/pages/rest-api/_meta.json b/pages/rest-api/_meta.json
@@ -1,5 +1,7 @@
 {
   "start": "Get Started",
-
-  "Actions": { "title": "Actions", "theme": { "collapsed": true } }
+  "Actions": { "title": "Actions", "theme": { "collapsed": true } },
+  "Emotes": { "title": "Emotes", "theme": { "collapsed": true } },
+  "Images": { "title": "Images", "theme": { "collapsed": true } },
+  "Texts": { "title": "Texts", "theme": { "collapsed": true } }
 }
diff --git a/pages/rest-api/start.mdx b/pages/rest-api/start.mdx
@@ -9,7 +9,7 @@ The base URL for the Waifu.it REST API is: [`https://waifu.it/api/:endpoint`](ht
 
 - Use the API token that you generate to authenticate each request made to the API.
 
-> If you don't have an API token, then just head over to https://docs.waifu.it/#frequently-asked-questions-faqs, then read and get one for free.
+> If you don't have an API token, then just head over to https://docs.waifu.it/faq, then read and get one for free.
 
  **Request Header**
 >
@@ -69,20 +69,20 @@ The base URL for the Waifu.it REST API is: [`https://waifu.it/api/:endpoint`](ht
 
 <Tabs items={["200 OK", "404 Not Found", "500 Internal Server Error"]}>
   <Tab>
-  **MIME Type:** `application/json`
+  **Content Type:** `application/json`
   ```json copy=false
   "status": 200,
   "message": {}
   ```
   </Tab>
   <Tab>
-  **MIME Type:** `application/json`
+  **Content Type:** `application/json`
   ```json copy=false
   "message": {}
   ```
   </Tab>
   <Tab>
-  **MIME Type:** `application/json`
+  **Content Type:** `application/json`
   ```json copy=false
   "message": {}
   ```

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"animefact": {`
`3`		`- "title": "anime-fact",`
	`3`	`+ "title": "anime-facts",`
`4`	`4`	`"theme": { "collapsed": true }`
`5`	`5`	`}`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`{`
`2`		`- "search": "Search"`
	`2`	`+ "getstarted": "Get Started",`
	`3`	`+ "generatefact": "Generate Fact"`
`3`	`4`	`}`