fix: sanitize code from the TOC #1204
Conversation
✅ Deploy Preview for asyncapi-website ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
There was a problem hiding this comment.
Left two suggestions that can improve your code. Also, you have to add string-sanitizer to the package.json file or, otherwise, it won't work outside your machine because it won't be installed (that's why tests are failing).
That said, if the only thing we have to sanitize in ToC is the backtick symbol (`), then also consider just removing it yourself instead of using the string-sanitizer dependency. I'm saying this because the more dependencies we have the slower the project becomes. You can replace the backticks yourself by using https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replaceAll:
item.content.replaceAll('`', '')☝️ this will replace all backticks with "nothing", i.e., will delete them.
Hope that helps!
Co-authored-by: Fran Méndez <fmvilas@gmail.com>
Co-authored-by: Fran Méndez <fmvilas@gmail.com>
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-1204--asyncapi-website.netlify.app/ |
There was a problem hiding this comment.
LGTM @Florence-Njeri. Approved ✔️. TOC doesn't have backticks for the headers.
|
hey @fmvilas, we need your approval (or review) as we can't merge without it because you requested changes. ✌🏽 |
|
@fmvilas sir mister please approve as you are our almighty blocker here 😋 |
15d5e74
|
/rtm |
|
@allcontributors please add @Florence-Njeri for code |
|
I've put up a pull request to add @Florence-Njeri! 🎉 |
Description
The generator docs render XML markup code snippets in the TOC. This PR sanitizes the headers before they are rendered in the TOC.
Related issue(s)
Fix Issue #1186