diff --git a/apps/docs/.gitignore b/apps/docs/.gitignore index f206ea41..19dd7480 100644 --- a/apps/docs/.gitignore +++ b/apps/docs/.gitignore @@ -33,4 +33,7 @@ yarn-error.log* # typescript *.tsbuildinfo -next-env.d.ts \ No newline at end of file +next-env.d.ts + +# documentation output +output.json \ No newline at end of file diff --git a/apps/docs/output.json b/apps/docs/output.json deleted file mode 100644 index 3cabb741..00000000 --- a/apps/docs/output.json +++ /dev/null @@ -1,102 +0,0 @@ -{ - "id": 0, - "name": "Guilded.JS", - "variant": "project", - "kind": 1, - "flags": {}, - "children": [ - { - "id": 1, - "name": "@guildedjs/api", - "variant": "declaration", - "kind": 2, - "flags": {} - }, - { - "id": 2, - "name": "@guildedjs/gil", - "variant": "declaration", - "kind": 2, - "flags": {} - }, - { - "id": 3, - "name": "guilded.js", - "variant": "declaration", - "kind": 2, - "flags": {} - } - ], - "packageName": "@guildedjs/main", - "readme": [ - { - "kind": "text", - "text": "
\r\n \"guildedjs\"/\r\n

Tools for interacting with the official Guilded.gg API.

\r\n
\r\n

\r\n \r\n \"CI\"\r\n \"License:
\r\n

\r\n
\r\n\r\n> ### Looking for maintainers!\r\n>\r\n> Do you have an interest in the Guilded API and have prior experience with working with typescript libraries? Make an issue in this github repository or shoot us a message in our [Guilded Server](https://www.guilded.gg/guildedjs)!\r\n\r\n## 📝 About\r\n\r\nThis repo serves as a monorepo that houses several packages, mainly the " - }, - { - "kind": "code", - "text": "`guilded.js`" - }, - { - "kind": "text", - "text": " package, which is a library for the Guilded API.\r\n\r\n## 📦 Packages\r\n\r\n- " - }, - { - "kind": "code", - "text": "`guilded.js`" - }, - { - "kind": "text", - "text": " (**[GitHub](https://github.com/zaida04/guilded.js/tree/main/packages/guilded.js#readme), [NPM](https://www.npmjs.com/package/guilded.js)**) - Main library that ties everything together. Has additional logic for caching.\r\n- " - }, - { - "kind": "code", - "text": "`@guildedjs/gil`" - }, - { - "kind": "text", - "text": " (**[GitHub](https://github.com/zaida04/guilded.js/tree/main/packages/gil#readme), [NPM](https://www.npmjs.com/package/@guildedjs/gil)**) - Framework allowing you to build bots with ease.\r\n- " - }, - { - "kind": "code", - "text": "`@guildedjs/api`" - }, - { - "kind": "text", - "text": " (**[GitHub](https://github.com/zaida04/guilded.js/tree/main/packages/api#readme), [NPM](https://www.npmjs.com/package/@guildedjs/api)**) - Multi-use wrapper over the entire Guilded APi. Utilities for making REST requests to the Guilded API with ratelimit handling. Also contains utilities for connecting to Guilded's WebSocket gateway and receiving events.\r\n\r\n## 📥 Installation\r\n\r\n\"NPM\"\r\n\r\n**Recommended that you use node v12+**\r\n\r\n- " - }, - { - "kind": "code", - "text": "`npm install guilded.js`" - }, - { - "kind": "text", - "text": "\r\n- " - }, - { - "kind": "code", - "text": "`yarn add guilded.js`" - }, - { - "kind": "text", - "text": "\r\n\r\n## ⚡ Usage\r\n\r\nYou can find extra examples [here](https://github.com/guildedjs/examples/tree/main/examples)\r\n\r\n" - }, - { - "kind": "code", - "text": "```ts\r\nconst { Client } = require(\"guilded.js\");\r\n// import { Client } from \"guilded.js\";\r\nconst client = new Client({ token: \"TOKEN_HERE\" });\r\n\r\nclient.on(\"ready\", () => console.log(`Bot is successfully logged in`));\r\nclient.on(\"messageCreated\", (message) => {\r\n if (message.content === \"test\") {\r\n return message.reply(\"test indeed\");\r\n }\r\n});\r\n\r\nclient.login();\r\n```" - }, - { - "kind": "text", - "text": "\r\n\r\n## 📃 Documentation\r\n\r\n> ### Looking for all the Client events? See [here](https://guildedjs.github.io/types/guilded_js.ClientEvents.html)\r\n>\r\n> Documentation is viewable here: https://guilded.js.org \r\n> A general purpose guide is available here: https://guilded-js.gitbook.io/api-docs/\r\n\r\n\r\n\r\n## ✋ Contributing\r\n\r\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\r\n\r\nWe make use of [PNPM](https://pnpm.io/) and [Changeset](https://github.com/changesets/changesets) to manage our monorepo. It's recommended that if you plan on contributing, you use these tools.\r\n\r\nPlease run " - }, - { - "kind": "code", - "text": "`pnpm install -r`" - }, - { - "kind": "text", - "text": " in your local environment to properly locally symlink all the packages that depend on each other.\r\n\r\nPlease ensure your commits pass the test, lint, and build scripts.\r\n\r\n## 🤝 Acknowledgements\r\n\r\n[Discord.js](https://github.com/discordjs/discord.js) - Inspiration & derived work.\r\n\r\n## ⚖️ LICENSING\r\n\r\n> **Guilded.JS** © [zaida04](https://github.com/zaida04). All packages released under [MIT](https://github.com/zaida04/guilded.js/blob/main/LICENSE).\r\n\r\nMaintained by: [zaida04](https://github.com/zaida04), [Skillz4Killz](https://github.com/Skillz4Killz), [Uhuh](https://github.com/Uhuh), and [DaStormer](https://github.com/DaStormer)" - } - ], - "symbolIdMap": {} -}