guide icon indicating copy to clipboard operation
guide copied to clipboard

feat: update popular-topics/webhooks

Open dlchamp opened this issue 1 year ago • 7 comments

Description

Add content to popular-topics/webhooks

Relevant Issues

Closes #61

dlchamp avatar Aug 16 '23 15:08 dlchamp

I'm not sure if it's a limitation of docusaurus or it's just a skills issue, but it seems that wrapping list text with `` doesn't style it properly. Please advise if there is a way to make that work.

dlchamp avatar Aug 16 '23 15:08 dlchamp

I'm not sure if it's a limitation of docusaurus or it's just a skills issue, but it seems that wrapping list text with `` doesn't style it properly. Please advise if there is a way to make that work.

Could you elaborate on what you mean by "list text"? I'm not sure I understand

abhigyantrips avatar Aug 16 '23 16:08 abhigyantrips

I'm not sure if it's a limitation of docusaurus or it's just a skills issue, but it seems that wrapping list text with `` doesn't style it properly. Please advise if there is a way to make that work.

Could you elaborate on what you mean by "list text"? I'm not sure I understand

The line:

- <DocsLink reference="disnake.Webhook.partial">Webhook.partial()</DocsLink> - Create a Webhook with an `id`, webhook
  `token`, and optional `bot_token`

image

Rather than showing the ` it should convert it to a codeblock around those words.

dlchamp avatar Aug 16 '23 16:08 dlchamp

Seems like this happens any time a list item starts with a tag (even just <b>) - not sure why, since it works in the MDX playground, so it might be a docusaurus quirk?

shiftinv avatar Aug 16 '23 17:08 shiftinv

Turns out this is a MDX v1 issue, we'd have to update to the Docusaurus v3 alpha to use MDX v2: https://github.com/facebook/docusaurus/issues/8945. I'm not sure if updating is viable for us right now (@abhigyantrips?), especially given that there's only the initial v3 alpha from two months ago.

edit: as a workaround, <code> should work

shiftinv avatar Aug 16 '23 17:08 shiftinv

Turns out this is a MDX v1 issue, we'd have to update to the Docusaurus v3 alpha to use MDX v2: facebook/docusaurus#8945. I'm not sure if updating is viable for us right now (@abhigyantrips?), especially given that there's only the initial v3 alpha from two months ago.

edit: as a workaround, <code> should work

Yeah, that's why we haven't updated to v3 yet. I've been looking at showcase sites though, it has been working well in prod.

But yeah I used <code> whenever the issue came up while writing.

abhigyantrips avatar Aug 16 '23 17:08 abhigyantrips

I didn't like the way it looked, so I just axed it altogether and reworded the lines having that issue.

dlchamp avatar Aug 16 '23 18:08 dlchamp