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

Add markdown support for version reminders #1826

Merged
merged 11 commits into from
Apr 3, 2024

Conversation

SajidAlamQB
Copy link
Contributor

@SajidAlamQB SajidAlamQB commented Mar 27, 2024

Description

Related to: #1786

The reminder pop-up notification doesn't parse markdown ` backticks this PR will attempt to add support for it using markdown-it.

Development notes

image

Checklist

  • Read the contributing guidelines
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added new entries to the RELEASE.md file
  • Added tests to cover my changes

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
SajidAlamQB and others added 2 commits March 27, 2024 14:51
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
Copy link
Contributor

@rashidakanchwala rashidakanchwala left a comment

Choose a reason for hiding this comment

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

I was considering that, given the simplicity of our markdown needs—primarily replacing backticks with code-blocks —we could directly use < code > tags for any backticks we encounter. This approach would eliminate the need for any additional dependencies. What do you think?

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
…edro-org/kedro-viz into feat/reminder-markdown-support

Signed-off-by: Sajid Alam <sajid_alam@mckinsey.com>
@SajidAlamQB SajidAlamQB requested a review from NeroOkwa as a code owner March 28, 2024 13:47
@SajidAlamQB
Copy link
Contributor Author

I was considering that, given the simplicity of our markdown needs—primarily replacing backticks with code-blocks —we could directly use < code > tags for any backticks we encounter. This approach would eliminate the need for any additional dependencies. What do you think?

That makes sense, I thought we wanted to support more markdown overall, happy to go with that instead.

@jitu5
Copy link
Contributor

jitu5 commented Apr 2, 2024

@SajidAlamQB If we are not planing to add more style to <code> block then everything else looks good to me.

Copy link
Contributor

@jitu5 jitu5 left a comment

Choose a reason for hiding this comment

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

LGTM!

@SajidAlamQB SajidAlamQB merged commit e3d4040 into main Apr 3, 2024
5 checks passed
@SajidAlamQB SajidAlamQB deleted the feat/reminder-markdown-support branch April 3, 2024 10:22
@jitu5 jitu5 mentioned this pull request Apr 16, 2024
5 tasks
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.

3 participants