diff --git a/package.json b/package.json index 4ab6679..cb8ad2b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "docs.waifu.it", - "version": "2.0.1", + "version": "2.0.2", "description": "The new and improved documentation for Waifu.it", "scripts": { "dev": "next dev", @@ -9,13 +9,13 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/WaifuAPI/docs.waifu.it.git" + "url": "git+https://github.com/WaifuAPI/Documentation.git" }, "license": "MIT", "bugs": { - "url": "https://github.com/WaifuAPI/docs.waifu.it/issues" + "url": "https://github.com/WaifuAPI/Documentation/issues" }, - "homepage": "https://github.com/WaifuAPI/docs.waifu.it/#readme", + "homepage": "https://github.com/WaifuAPI/Documentation/#readme", "dependencies": { "next": "^13.0.6", "nextra": "2.0.1", diff --git a/pages/_meta.json b/pages/_meta.json index de6b2f0..debc191 100644 --- a/pages/_meta.json +++ b/pages/_meta.json @@ -7,7 +7,7 @@ "license": { "title": "License 📝", "type": "page", - "href": "https://raw.githubusercontent.com/WaifuAPI/docs.waifu.it/master/LICENSE", + "href": "https://raw.githubusercontent.com/WaifuAPI/Waifu.it/production/LICENCE.md", "newWindow": true }, "contact": { diff --git a/pages/libraries/Javascript/_meta.json b/pages/libraries/Javascript/_meta.json index 1d38d3c..6427d07 100644 --- 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 index 3cf6b01..6e4dab1 100644 --- 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 new file mode 100644 index 0000000..2616ade --- /dev/null +++ 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 + + + + <> + ```js + import AnimeFact from "anime-facts"; + + // Replace with your API Token + const api = new AnimeFact(""); + api.getFact().then((res) => console.log(res)); + ``` + + + + + +## Response Schema + + + + **Content Type:** `application/json` + ```json copy=false +{ + "id": 5, + "fact": "TEZUKA Osamu is the most famous manga artist in Japan.", +} + ``` + + diff --git a/pages/libraries/Javascript/animefact/getstarted.mdx b/pages/libraries/Javascript/animefact/getstarted.mdx new file mode 100644 index 0000000..cf4c5ff --- /dev/null +++ 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. */} + + + + ```bash + npm i anime-facts + ``` + View package at [npmjs.com](https://www.npmjs.com/package/anime-facts) + + + ```bash + yarn add anime-facts + ``` + View package at [yarnpkg.com](https://yarnpkg.com/package/anime-facts) + + \ No newline at end of file diff --git a/pages/libraries/start.mdx b/pages/libraries/start.mdx index cb8a5ff..321d07a 100644 --- 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/list-of-endpoints.mdx b/pages/list-of-endpoints.mdx index 61cea72..ed4a781 100644 --- a/pages/list-of-endpoints.mdx +++ b/pages/list-of-endpoints.mdx @@ -4,16 +4,25 @@ Waifu.it supports a wealth of endpoints, which can be categorized into the follo ## Actions -[Angry:](http://localhost:3000/rest-api/Actions/Angry/search) This endpoint returns a random anime GIF with the angry reaction. +[Angry:](https://docs.waifu.it/rest-api/Actions/Angry/search) This endpoint returns a random anime GIF with the angry reaction. -[Baka:](https://example.com) This endpoint returns a random anime GIF with the baka or idiot reaction. +[Baka:](https://docs.waifu.it/rest-api/Actions/Baka/search) This endpoint returns a random anime GIF with the baka or idiot reaction. ## Emotes -[Blush:](https://example.com) This endpoint returns a random anime GIF with Blush. +[Blush:](https://docs.waifu.it/rest-api/Emotes/Blush/search) This endpoint returns a random anime GIF with Blush. +## Images + +[Waifu:](https://docs.waifu.it/rest-api/Images/Waifu/search) Serves with a random anime waifu image with some of it's information. ## Texts -[Fact:](https://example.com) Serves with a random anime fact. \ No newline at end of file +[Fact:](https://docs.waifu.it/rest-api/Texts/Fact/search) Serves with a random anime fact. + +[Password:](https://docs.waifu.it/rest-api/Texts/Password/search) Generate's a random `base64` string. + +[Quote:](https://docs.waifu.it/rest-api/Texts/Quote/search) Serves with a random anime quote. + +[Tags:](https://docs.waifu.it/rest-api/Texts/Tags/search) Response with the available tags for query in certain endpoints. \ No newline at end of file diff --git a/pages/rest-api/Emotes/Blush/_meta.json b/pages/rest-api/Emotes/Blush/_meta.json new file mode 100644 index 0000000..3cf6b01 --- /dev/null +++ b/pages/rest-api/Emotes/Blush/_meta.json @@ -0,0 +1,3 @@ +{ + "search": "Search" +} diff --git a/pages/libraries/Javascript/animefact/search.mdx b/pages/rest-api/Emotes/Blush/search.mdx similarity index 100% rename from pages/libraries/Javascript/animefact/search.mdx rename to pages/rest-api/Emotes/Blush/search.mdx diff --git a/pages/rest-api/Emotes/_meta.json b/pages/rest-api/Emotes/_meta.json new file mode 100644 index 0000000..0a23e99 --- /dev/null +++ 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 new file mode 100644 index 0000000..3cf6b01 --- /dev/null +++ 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 new file mode 100644 index 0000000..1cd5d2a --- /dev/null +++ b/pages/rest-api/Images/Waifu/search.mdx @@ -0,0 +1 @@ +owo WIP \ No newline at end of file diff --git a/pages/rest-api/Images/_meta.json b/pages/rest-api/Images/_meta.json new file mode 100644 index 0000000..65698c4 --- /dev/null +++ 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 new file mode 100644 index 0000000..3cf6b01 --- /dev/null +++ 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 new file mode 100644 index 0000000..1cd5d2a --- /dev/null +++ b/pages/rest-api/Texts/Fact/search.mdx @@ -0,0 +1 @@ +owo WIP \ No newline at end of file diff --git a/pages/rest-api/Texts/Password/_meta.json b/pages/rest-api/Texts/Password/_meta.json new file mode 100644 index 0000000..3cf6b01 --- /dev/null +++ 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 new file mode 100644 index 0000000..1cd5d2a --- /dev/null +++ b/pages/rest-api/Texts/Password/search.mdx @@ -0,0 +1 @@ +owo WIP \ No newline at end of file diff --git a/pages/rest-api/Texts/Quote/_meta.json b/pages/rest-api/Texts/Quote/_meta.json new file mode 100644 index 0000000..3cf6b01 --- /dev/null +++ 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 new file mode 100644 index 0000000..1cd5d2a --- /dev/null +++ b/pages/rest-api/Texts/Quote/search.mdx @@ -0,0 +1 @@ +owo WIP \ No newline at end of file diff --git a/pages/rest-api/Texts/Tags/_meta.json b/pages/rest-api/Texts/Tags/_meta.json new file mode 100644 index 0000000..3cf6b01 --- /dev/null +++ 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 new file mode 100644 index 0000000..1cd5d2a --- /dev/null +++ b/pages/rest-api/Texts/Tags/search.mdx @@ -0,0 +1 @@ +owo WIP \ No newline at end of file diff --git a/pages/rest-api/Texts/_meta.json b/pages/rest-api/Texts/_meta.json new file mode 100644 index 0000000..e5c5df6 --- /dev/null +++ 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 index fbf9af9..e82d7dd 100644 --- 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 index cd89d27..d2bfc60 100644 --- 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 - **MIME Type:** `application/json` + **Content Type:** `application/json` ```json copy=false "status": 200, "message": {} ``` - **MIME Type:** `application/json` + **Content Type:** `application/json` ```json copy=false "message": {} ``` - **MIME Type:** `application/json` + **Content Type:** `application/json` ```json copy=false "message": {} ``` diff --git a/theme.config.tsx b/theme.config.tsx index 8b8cac8..54d9e26 100644 --- a/theme.config.tsx +++ b/theme.config.tsx @@ -8,7 +8,7 @@ const config: DocsThemeConfig = { }, faviconGlyph: "🚧", banner: { - text: "🚧 The Waifu.it documentation is undergoing reconstruction. Please be patient for it to be fully-documented. 🚧", + text: "🚧 Documentation is undergoing reconstruction 🚧", }, logo: Documentation, navbar: { @@ -48,12 +48,12 @@ const config: DocsThemeConfig = { }, }, project: { - link: "https://github.com/", + link: "https://github.com/WaifuAPI", }, chat: { - link: "https://discord.gg/", + link: "https://discord.gg/yyW389c", }, - docsRepositoryBase: "https://github.com/Waifu.it/docs.Waifu.it.org", + docsRepositoryBase: "https://github.com/WaifuAPI/Documentation/tree/production", footer: { text: "© 2021-2023 Waifu.it", },