Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix unparsed markdown in ClientOptions documentation #10582

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

NitinBilla10
Copy link

@NitinBilla10 NitinBilla10 commented Oct 25, 2024

This PR addresses an issue in the ClientOptions documentation where markdown elements such as **bold** text and [links](url) were not being properly parsed and rendered. The issue was resolved by updating the parsing logic to handle these markdown elements correctly. I refactored the documentation generation code to ensure that elements like bold and [links](url) are now properly rendered. This improves readability and accuracy of the documentation for users.

Status and versioning classification:

  • Code changes have been tested against the Discord API, or there are no code changes.
  • I know how to update typings and have done so, or typings don't need updating.
  • This PR only includes non-code changes (documentation).

NitinBilla10 and others added 3 commits October 25, 2024 16:08
Corrected the markdown rendering for `ClientOptions` to properly parse bold text and links. This fixes the issue where markdown elements were not displaying as intended.

Closes discordjs#10558
Copy link

vercel bot commented Oct 25, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
discord-js ⬜️ Ignored (Inspect) Oct 25, 2024 11:23am
discord-js-guide ⬜️ Ignored (Inspect) Oct 25, 2024 11:23am

@Qjuh
Copy link
Contributor

Qjuh commented Oct 25, 2024

Did you test that this actually achieves what you claim it achieves? Because there is no DocNodeKind named BoldText.
Also you (accidentally) bumped the discord.js version and committed the changelog for that bump, which is definitely out of scope for this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

2 participants