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

Refactor from More Features to Embeds, Events, Markdown #236

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

Conversation

Elitesparkle
Copy link
Contributor

Split the More Features page into 3 separate pages: Embeds, Events, Markdown. Furthermore, add Related Topics to connect the Embeds page and the Markdown page to each other.

@Lulalaby Lulalaby linked an issue Oct 16, 2022 that may be closed by this pull request
@BobDotCom
Copy link
Member

I added a couple markdown examples, and moved the element style pages into their own category.

Comment on lines +82 to +83
message = "Hello world!"
print(message)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: this doesn't format correctly at the moment. Fix before merging. May be resolved by #239.

@netlify
Copy link

netlify bot commented Oct 17, 2022

Deploy Preview for pycord ready!

Name Link
🔨 Latest commit 884561d
🔍 Latest deploy log https://app.netlify.com/sites/pycord/deploys/63513d147df5d900093994cc
😎 Deploy Preview https://deploy-preview-236--pycord.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Elitesparkle and others added 3 commits October 18, 2022 00:37
Add the "text" flag to code blocks that aren't supposed to show with syntax highlight as they are about an example without it.

Split the Code Block and Quote Block sections into paragraphs.

Add an example for single-line code block with syntax highlight.

Improve some sentences here and there.
@Elitesparkle
Copy link
Contributor Author

Elitesparkle commented Oct 17, 2022

There are 3 warnings about quote blocks inside Discord examples. I'm not sure if they need to be changed and how.

Fixed. No more warnings but the examples are showing wrong.

Elitesparkle and others added 6 commits October 19, 2022 16:55
The syntax isn't exactly the one explained immediately above but the final result looks exactly the same and we hopefully no longer get any warning there.
<DiscordComponent>
<DiscordMessage profile="robocord">
<DiscordMarkdown>
```
Copy link
Contributor Author

@Elitesparkle Elitesparkle Oct 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want to show this example properly, this code block should be rendered with syntax highlight. Since it was showing python as text, I reverted the change for now. The next 2 examples have the same problem.

<DiscordComponent>
<DiscordMessage profile="robocord">
<DiscordMarkdown>
> This is a
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we write >>>, we get an error. If we write > for each line, the first line shows as quote block correctly but the second > shows as text instead of being rendered as quote block.

Copy link
Member

@BobDotCom BobDotCom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should always write the correct syntax, and change the discordcomponent if it fails to parse correctly

docs/getting-started/styling-messages/markdown.mdx Outdated Show resolved Hide resolved
docs/getting-started/styling-messages/markdown.mdx Outdated Show resolved Hide resolved
docs/getting-started/styling-messages/markdown.mdx Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

More Features should be split into Events, Embeds, and Markdown
2 participants