discordjs/website

The discord.js site what else

Vue 3 + Typescript + Vite

This template should help get you started developing with Vue 3 and Typescript in Vite.

Recommended IDE Setup

VSCode + Volar.

Using Volar

Run Volar: Switch TS Plugin on/off from VSCode command palette.

website's Issues

ShadikBot

L.

Update `Vite Plugin PWA` to `0.8.1` version

With 0.8.1 version, all pwa icons will be added to the service worker manifest, and you can also add favicon, robots.txt, fonts and additional file assets, see Static assets handling section.

Also fixed build crash when using vite web workers.

How create NPM Package with the same style as discordjs website

Hi, I've a question,

Have you got an explicative video that explain how create any npm package website docs with th same style as Discordjs website.

Or a website for learn how.

User Flags show EARLY_VERIFIED_BOT_OWNER, but it should be EARLY_VERIFIED_DEVELOPER

https://discord.com/channels/222078108977594368/223867697312694272/842079569941889085

Problem with the website's theme toggler

When the website is in dark mode -

When the website is in light mode -

Error in console while loading class

I decided to understand the documentation code and test it. Replaced everything you need, while an error appears in the console, and the page remains blank.

marked.js:2597 Uncaught (in promise) Error: marked(): input parameter is undefined or null
   at marked (marked.js:2597)
   at markdown (markdown.ts:30)
   at ClassEvent.vue:64
   at ComputedRefImpl.reactiveEffect [as effect] (reactivity.esm-bundler.js:42)
   at ComputedRefImpl.get value [as value] (reactivity.esm-bundler.js:864)
   at unref (reactivity.esm-bundler.js:778)
   at Object.get (reactivity.esm-bundler.js:781)
   at Proxy._sfc_render (ClassEvent.vue:32)
   at renderComponentRoot (runtime-core.esm-bundler.js:1166)
   at componentEffect (runtime-core.esm-bundler.js:5201)

I checked everything on the local machine.

Suggestion: create a PR on awesome vite to reference this template

https://github.com/vitejs/awesome-vite

"Emoji" spelt wrong on documentation

Various `|` (or) returns do not display correctly on the documentation

Which package is this bug report for?

discord.js

Issue description

At:

• CommandInteractionOptionResolver#getChannel()
• GuildChannelManager#resolve()
• CommandInteractionOptionResolver#getMentionable()

The Returns element does not resolve to a proper Foo|Bar format, instead resorting to FooBar (links do work as expected).
I was not able to find any more of these but there is a big chance there are more than just these 3.

https://github.com/discordjs/discord.js/blob/950fc47234ed7702a20c90246823a5215c75e84f/packages/discord.js/src/structures/CommandInteractionOptionResolver.js#L146

https://github.com/discordjs/discord.js/blob/950fc47234ed7702a20c90246823a5215c75e84f/packages/discord.js/src/managers/GuildChannelManager.js#L84

https://github.com/discordjs/discord.js/blob/950fc47234ed7702a20c90246823a5215c75e84f/packages/discord.js/src/structures/CommandInteractionOptionResolver.js#L261

Example:

Code sample

No response

Package version

Does not apply

Node.js version

Does not apply

Operating system

Chrome 111.0.5563.64, also tested on Safari 14.1.2

Priority this issue should have

Low (slightly annoying)

Which partials do you have configured?

Not applicable (subpackage bug)

Which gateway intents are you subscribing to?

Not applicable (subpackage bug)

I have tested this issue on a development release

No response

Use the new link to @discordjs/voice

Change the last item in the list (@discordjs/voice) for the new link (@discordjs/voice). It is in welcome page.

update the documentation pages

The documentation page is apparently very outdated according to Benjamin Kirby and should really be updated or removed.

Expand all extended typedefs by default

Discord.js has multiple typedefs which type is not an Object, but instead points to another base typedef. An example of this is MessageActionRowOptions and this is how it looks when you first open the page:

What I'd like to suggest is for the extended typedef(s) to always be extended by default so that users don't accidentally miss important properties that are required/accepted in a typedef. I remember suggesting this once and being told that it would be hard to tell which ones should be expanded and which ones shouldn't, which is why I'm suggesting to expand all by default and let the user then close whichever ones they don't need to see. I believe the typedef with the most extended typedefs has 2 of them so this shouldn't be much of a problem either.

Option to disable realtime search

A option that will disable realtime search and it will only goto search page when you hit enter

Expanding typedefs with info/warn blocks doesn't display their properties

When expanding an extended typedef that has an info or warn block in it, the website will not display the extended typedef's properties unless you click on the typedef link to go to its page. A good example of this is the SetApplicationCommandPermissionsOptions typedef, which looks like this when expanded

Clicking on the 'dispose' event on ReactionCollector sends you to the method instead

Clicking on the dispose event here on this page brings you to the dispose method, not the event.

Consider adjusting color a bit?

The color of new main page's "most popular" label and top note kills my eyes, almost like the plain blue color (rgb(0, 0, 255)). I know this is extremely opinionated, but may it be possible to adjust this color to, e.g., rgb(37, 48, 153) or old "main" color (rgb(48, 57, 149))? Screenshots attached for ease of preview.

Updated color:

Current color:

Dynamically direct GitHub anchor to current page

Now when you click the GitHub button in the header it links you to GitHub/discordjs/discord.js
Wouldn't it be much more useful to dynamically change the anchor to link you to the current page you're in
If I would be on Guild it would link to structures/Guild.js
I've noticed this and think it's anoying that it's not this way. It's way more complicated to navigate from the root to structures/Guild.js than from structures/Guild.js to root

Couldn't load the documentation data. TypeError: NetworkError when attempting to fetch resource.

When I got to https://discord.js.org/#/docs/discord.js/main/general/welcome I see Couldn't load the documentation data. TypeError: NetworkError when attempting to fetch resource..

Here's is a fuller log from Firefox's console:

Failed to load ‘https://api.npmjs.org/downloads/range/2013-08-21:2100-08-21/discord.js’. A ServiceWorker passed a promise to FetchEvent.respondWith() that rejected with ‘Error: no-response :: [{"url":"https://api.npmjs.org/downloads/range/2013-08-21:2100-08-21/discord.js"}]’. [sw.js:1:626](https://discord.js.org/sw.js)
Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at https://api.npmjs.org/downloads/range/2013-08-21:2100-08-21/discord.js. (Reason: CORS request did not succeed). Status code: (null).

Failed to load ‘https://docs.discordjs.dev/docs/discord.js/main.json’. A ServiceWorker passed a promise to FetchEvent.respondWith() that rejected with ‘Error: no-response :: [{"url":"https://docs.discordjs.dev/docs/discord.js/main.json"}]’. [sw.js:1:626](https://discord.js.org/sw.js)
Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at https://docs.discordjs.dev/docs/discord.js/main.json. (Reason: CORS request did not succeed). Status code: (null).

Failed to load ‘https://docs.discordjs.dev/docs/discord.js/main.json’. A ServiceWorker passed a promise to FetchEvent.respondWith() that rejected with ‘Error: no-response :: [{"url":"https://docs.discordjs.dev/docs/discord.js/main.json"}]’. [sw.js:1:626](https://discord.js.org/sw.js)
Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at https://docs.discordjs.dev/docs/discord.js/main.json. (Reason: CORS request did not succeed). Status code: (null).

Error: Promised response from onMessage listener went out of scope

You're technically breaking §4 of the js.org ToS

https://js.org/terms.html

§ 4 Rights and Duties of the user

[..]
The user is obliged to publish legals on his website which contains at least the full name, mailing address and an e-mail adress.

I don't think these legalities are published anywhere on the main discord.js.org site.

Can't access docs: TypeError: NetworkError when attempting to fetch resource."

I can't access the documentation. Error from the console:

Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at https://raw.githubusercontent.com/discordjs/discord.js/docs/stable.json. (Reason: CORS request did not succeed).
Failed to load ‘https://raw.githubusercontent.com/discordjs/discord.js/docs/stable.json’. A ServiceWorker passed a promise to FetchEvent.respondWith() that rejected with ‘Error: no-response :: [{"url":"https://raw.githubusercontent.com/discordjs/discord.js/docs/stable.json"}]’. sw.js:1:594
Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at https://api.npmjs.org/downloads/range/2013-08-21:2100-08-21/discord.js. (Reason: CORS request did not succeed).
Failed to load ‘https://api.npmjs.org/downloads/range/2013-08-21:2100-08-21/discord.js’. A ServiceWorker passed a promise to FetchEvent.respondWith() that rejected with ‘Error: no-response :: [{"url":"https://api.npmjs.org/downloads/range/2013-08-21:2100-08-21/discord.js"}]’. sw.js:1:594
The resource at “https://discord.js.org/assets/docs.eea0cb6a.js” preloaded with link preload was not used within a few seconds. Make sure all attributes of the preload tag are set correctly. discord.js.org
The resource at “https://discord.js.org/assets/chevron-down.40ab8f75.js” preloaded with link preload was not used within a few seconds. Make sure all attributes of the preload tag are set correctly. discord.js.org
The resource at “https://discord.js.org/assets/headlessui.esm.ddfe9e3e.js” preloaded with link preload was not used within a few seconds. Make sure all attributes of the preload tag are set correctly. discord.js.org
The resource at “https://discord.js.org/assets/Spinner.ce5d90e3.js” preloaded with link preload was not used within a few seconds. Make sure all attributes of the preload tag are set correctly. discord.js.org
The resource at “https://discord.js.org/assets/[file].9f107064.js” preloaded with link preload was not used within a few seconds. Make sure all attributes of the preload tag are set correctly. discord.js.org
The resource at “https://discord.js.org/assets/SourceButton.vue_vue&type=script&setup=true&lang.daca1f17.js” preloaded with link preload was not used within a few seconds. Make sure all attributes of the preload tag are set correctly. discord.js.org

[Bug] Documentation will fail to load after first visit when HTTPS only is enabled

Expected Behaviour

When reloading or re-visiting the documentation, it should load.

Current Behaviour

After reloading or re-visiting, the documentation will fail to load with the error:

Couldn't load the documentation data.
TypeError: NetworkError when attempting to fetch resource.

Console log

Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at https://raw.githubusercontent.com/discordjs/docs/main/discord.js/stable.json. (Reason: CORS request did not succeed). Status code: (null).

Failed to load 'https://raw.githubusercontent.com/discordjs/docs/main/discord.js/stable.json'. A ServiceWorker passed a promise to FetchEvent.respondWith() that rejected with 'Error: no-response :: [{"url":"https://raw.githubusercontent.com/discordjs/docs/main/discord.js/stable.json"}]'. [sw.js:1:581](https://discord.js.org/sw.js)
Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at https://api.github.com/repos/discordjs/discord.js. (Reason: CORS request did not succeed). Status code: (null).

Failed to load 'https://api.github.com/repos/discordjs/discord.js'. A ServiceWorker passed a promise to FetchEvent.respondWith() that rejected with 'Error: no-response :: [{"url":"https://api.github.com/repos/discordjs/discord.js"}]'. [sw.js:1:581](https://discord.js.org/sw.js)
Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at https://api.github.com/repos/discordjs/discord.js/stats/contributors. (Reason: CORS request did not succeed). Status code: (null).

Failed to load 'https://api.github.com/repos/discordjs/discord.js/stats/contributors'. A ServiceWorker passed a promise to FetchEvent.respondWith() that rejected with 'Error: no-response :: [{"url":"https://api.github.com/repos/discordjs/discord.js/stats/contributors"}]'. [sw.js:1:581](https://discord.js.org/sw.js)
TypeError: NetworkError when attempting to fetch resource. [index.154d11fb.js:1:1235](https://discord.js.org/assets/index.154d11fb.js)
Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at https://api.github.com/repos/discordjs/discord.js/tags. (Reason: CORS request did not succeed). Status code: (null).

Failed to load 'https://api.github.com/repos/discordjs/discord.js/tags'. A ServiceWorker passed a promise to FetchEvent.respondWith() that rejected with 'Error: no-response :: [{"url":"https://api.github.com/repos/discordjs/discord.js/tags"}]'. [sw.js:1:581](https://discord.js.org/sw.js)
Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at https://api.github.com/repos/discordjs/discord.js/branches. (Reason: CORS request did not succeed). Status code: (null).

Failed to load 'https://api.github.com/repos/discordjs/discord.js/branches'. A ServiceWorker passed a promise to FetchEvent.respondWith() that rejected with 'Error: no-response :: [{"url":"https://api.github.com/repos/discordjs/discord.js/branches"}]'. [sw.js:1:581](https://discord.js.org/sw.js)
Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource at https://api.npmjs.org/downloads/range/2013-08-21:2100-08-21/discord.js. (Reason: CORS request did not succeed). Status code: (null).

Failed to load 'https://api.npmjs.org/downloads/range/2013-08-21:2100-08-21/discord.js'. A ServiceWorker passed a promise to FetchEvent.respondWith() that rejected with 'Error: no-response :: [{"url":"https://api.npmjs.org/downloads/range/2013-08-21:2100-08-21/discord.js"}]'. [sw.js:1:581](https://discord.js.org/sw.js)
The resource at “https://discord.js.org/assets/docs.b7d139dd.js” preloaded with link preload was not used within a few seconds. Make sure all attributes of the preload tag are set correctly. [discord.js.org](https://discord.js.org/#/docs/discord.js/stable/general/welcome)
The resource at “https://discord.js.org/assets/chevron-down.046bf525.js” preloaded with link preload was not used within a few seconds. Make sure all attributes of the preload tag are set correctly. [discord.js.org](https://discord.js.org/#/docs/discord.js/stable/general/welcome)
The resource at “https://discord.js.org/assets/headlessui.esm.5f2b3dc4.js” preloaded with link preload was not used within a few seconds. Make sure all attributes of the preload tag are set correctly. [discord.js.org](https://discord.js.org/#/docs/discord.js/stable/general/welcome)
The resource at “https://discord.js.org/assets/Spinner.c85b1c37.js” preloaded with link preload was not used within a few seconds. Make sure all attributes of the preload tag are set correctly. [discord.js.org](https://discord.js.org/#/docs/discord.js/stable/general/welcome)
The resource at “https://discord.js.org/assets/[file].793fe219.js” preloaded with link preload was not used within a few seconds. Make sure all attributes of the preload tag are set correctly. [discord.js.org](https://discord.js.org/#/docs/discord.js/stable/general/welcome)
The resource at “https://discord.js.org/assets/SourceButton.vue_vue&type=script&setup=true&lang.0296927c.js” preloaded with link preload was not used within a few seconds. Make sure all attributes of the preload tag are set correctly. [discord.js.org](https://discord.js.org/#/docs/discord.js/stable/general/welcome)

Steps to Reproduce

1. Enable HTTPS only mode for the domain.
2. Clear cache and cookies for the domain.
3. Visit the documentation, it loads as expected.
4. Reload, the documentation now fails to load.

Detailed Description

I'm left with two options if I want to use the documentation,

• Disable HTTPS only mode for the domain.
• Load the site while in private browsing mode.

While turning HTTPS only off will allow the documentation to load, I'm uncomfortable doing so, even if it's just for this domain. So I'm stuck using the documentation in private browsing, otherwise it's completely unusable.
And private browsing is a poor experience for my workflow. (Re-logging into everything anytime I work with the Discord.js API wrapper is a pain in the ass.)

User agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:98.0) Gecko/20100101 Firefox/98.0

Is there a way to programmatically search the Discord.js docs?

I'm trying to create a command in a Discord.js bot that searches the Discord.js documentation. However, I have come across difficulties due to the way scripts are run dynamically in order to fetch the search results.

Is there a script that I can access to get the search results instead of attempting to scrape the Discord.js documentation website. If so, how would I go about using that script (using Node.js)?

I'm not sure if this issue should be here or in the Discord.js module repository. Please notify me if it should be moved.

By the way, thank you for such a great module. I am very grateful for the work you have put in. I hope you continue to make Discord.js the best it can possibly be.

Discord.js Docs site Down

Hi,
I think something went wrong with the new commits not entirely sure what but can't really open the docs site... or is it purposely down?

Docs Unavailable

Which package is this bug report for?

discord.js

Issue description

Trying to navigate to the docs doesn't work.

Repro:

1. Open the URL https://discord.js.org/#/docs/discord.js/main/general/welcome

Outcome:
The following text is displayed:

Couldn't load the documentation data.
Error: Failed to fetch docs data file from GitHub

Code sample

No response

Package version

14.1.1

Node.js version

16.16.0

Operating system

No response

Priority this issue should have

Medium (should be fixed soon)

Which partials do you have configured?

Not applicable (subpackage bug)

Which gateway intents are you subscribing to?

Not applicable (subpackage bug)

I have tested this issue on a development release

No response

Build badge link not updated

The build badge on https://discord.js.org/#/docs/main/stable/general/welcome has not been updated, it redirects to https://travis-ci.org/hydrabolt/discord.js while it should redirect to https://travis-ci.org/discordjs/discord.js

I tried to fix it but couldn't find the file where the code for it is located.

Make docs easily accessible

Is your feature request related to a problem? Please describe.
I find it difficult when typing in the entire link to get to the docs, I wish there was a simpler way to access them.

Describe the ideal solution
Redirect users who go to "https://discord.js.org/docs" to the latest stable docs ("https://discord.js.org/#/docs/main/stable/general/welcome")

The discord.js.org website scrollTo broken

Sometimes when the page dont load fast enough the scrollTo param doesent work. maybe wait for the page to load before doing the scroll to?

Example code in collections doc shows backticks

Under the @discordjs/collection docs, when there is an example, the backticks still show:
https://discord.js.org/#/docs/collection/main/class/Collection?scrollTo=each

Consider using a max-w-prose class on the homepage

The two paragraphs on the homepage tend to expand as the screen width increases. This can negatively impact readability.

Below is what the page looks like when the tailwind class max-w-prose is applied to the div container for the 2 paragraphs.

Npm Install Clipboard

It would be fast and efficient if "npm install discord.js" in Discord JS Org website has a copy to clipboard button.

rename `sw.ts` to `service-worker.ts` to fix cache invalidation of old site

like title says, this will fix it.

No docs for BaseCollection on master

Since Collection on master branch now relies on BaseCollection from @discordjs/collection, the documentation points to supposed docs for that: https://discord.js.org/#/docs/collection (see https://github.com/discordjs/discord.js/blob/master/src/util/Collection.js#L21)

However, that documentation isn't generated / published and so it just redirects to docs homepage.

invalid link on page

if I go to https://discord.js.org/#/docs/builders/stable/general/welcome

There is the following link:

Here are some examples for the builders and utilities you can find in this package:
Slash Command Builders

But as far as I can tell, that page does not exist?

Allow docs search to search return / parameter / property types

Currently, the search does not consider return type of methods, type of parameters or type of properties for the search. This can make it hard to see where types are used.

Example: trying to find how to get an instance of ClientUser.

https://discord.js.org/#/docs/main/stable/search?q=ClientUser
This will not consider Client#user as a search result.

It would be great to be able to find all methods/properties that use or return a particular type.

Search doesn't properly link static properties/methods

When searching for a static property - say Intents.FLAGS - search will send you to the correct class page, however, the scrollTo argument will be missing the s- prefix that indicates that a property or method is static and thus failing to scroll to it.

Change the website title when viewing a property

So today I have a suggestion: change the website title based on the property you are viewing.

Why?
If you use discord.js (or any other library), you know that sometimes you need to open a lot of tabs, and it's annoying to switch between the tabs to find a specific page you've previously opened, because it's always discord.js. With the page named with the property name (and maybe the type), it would be much easier, like BaseClient - discord.js/BaseClient (class) - discord.js.

docs down??

sorry if im a moron... but i cant seem to load the docs? on two seperate pcs and browser, on my phone, and my friend cant load them either. is it down?