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

Updated note and tip format #346

Closed
wants to merge 4 commits into from
Closed

Conversation

LakshmiLavanyaKasturi
Copy link
Contributor

Fixed note and tip formats to render correctly on the docs repo.

@LakshmiLavanyaKasturi
Copy link
Contributor Author

@MicaiahReid Please review. Thanks!

Copy link
Contributor

@MicaiahReid MicaiahReid left a comment

Choose a reason for hiding this comment

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

Hey @LakshmiLavanyaKasturi! Do you know what the formatting is supposed to look like for text wrapped in:::note :::? It doesn't seem to be rendering when I view the file in github:
Screenshot 2023-07-23 at 1 50 43 PM

@LakshmiLavanyaKasturi
Copy link
Contributor Author

LakshmiLavanyaKasturi commented Jul 24, 2023

Hey @LakshmiLavanyaKasturi! Do you know what the formatting is supposed to look like for text wrapped in:::note :::? It doesn't seem to be rendering when I view the file in github: Screenshot 2023-07-23 at 1 50 43 PM

@MicaiahReid, I tested this by pulling these changes to docs repo and the preview looks like this:
image

@MicaiahReid
Copy link
Contributor

Ahh I think I know what's happening, @LakshmiLavanyaKasturi.

The :::note tag works on the website docs, but it doesn't work in the Github markdown renderer :(

Since many developers use the Github markdown for documentation, I think we'll need to make sure all markdown correctly renders on both. Do you know if it will be possible to render a note with the same formatting without using that :::note tag?

@LakshmiLavanyaKasturi
Copy link
Contributor Author

Closing this PR in favor of #373 as this PR got lot of merge conflicts with remote doc changes.

auto-merge was automatically disabled August 8, 2023 22:17

Pull request was closed

@lgalabru lgalabru deleted the fix-note-format branch September 18, 2023 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants