Add markdown support for version reminders

kedro-org / kedro-viz

Visualise your Kedro data and machine-learning pipelines and track your experiments.

https://demo.kedro.org

Apache License 2.0

647 stars 106 forks source link

Add markdown support for version reminders #1826

Closed SajidAlamQB closed 3 months ago

SajidAlamQB commented 3 months ago

Description

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

Development notes

Checklist

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

SajidAlamQB commented 3 months ago

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 commented 3 months ago

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