Kafkajs: Raw HTML shows on the documentation right side

[tulios]

This was caused by the docusaurus update, version 1.12.0 has the issue.

https://github.com/facebook/docusaurus/issues/1703

[ThisIsMissEm]

Hopefully, my patch to Docusaurus will be accepted and then we can have this:

Before	After

[ThisIsMissEm]

Though, also, we may not actually need those <a name="..."></a> tags anymore

[Nevon]

The only reason we want to keep them is that some error logs that we output contain links to help sections, so we need the anchors to be stable. We don't have that guarantee with the autogenerated ones, especially since we'd want the anchor to stay the same even if we change the actual title text.

[ThisIsMissEm]

@Nevon okay, this totally makes sense. In which case, my patch will fix the issue. Perhaps you'd like to give it a review?

[yangshun]

We don't have that guarantee with the autogenerated ones, especially since we'd want the anchor to stay the same even if we change the actual title text.

I see. I was wondering why you didn't use the autogenerated anchors and instead manually wrote your own. As a suggestion I think it'll be better to shift those anchors to the end of the heading to prevent it from taking up space. Currently by putting it at the start it takes up some one letter space (the pink highlighted "text") on https://kafka.js.org/docs/producing#a-name-custom-partitioner-a-custom-partitioner

[ThisIsMissEm]

Oh! Good point, we could do thar, but we'd still see anchors in the page's ToC without the docusaurus patch linked above

On 13. Sep 2019, at 23:40, Yangshun Tay [e-mail] wrote:

We don't have that guarantee with the autogenerated ones, especially since we'd want the anchor to stay the same even if we change the actual title text.

I see. I was wondering why you didn't use the autogenerated anchors and instead manually wrote your own. As a suggestion I think it'll be better to shift those anchors to the end of the heading to prevent it from taking up space. Currently by putting it at the start it takes up some one letter space (the pink highlighted "text"):

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub, or mute the thread.

[yangshun]

Yep, just merged your PR. Thank you! 😄

[ThisIsMissEm]

Amazing! Thanks ✨

On 13. Sep 2019, at 23:57, Yangshun Tay [e-mail] wrote:

Yep, just merged your PR. Thank you! 😄

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub, or mute the thread.

[tulios]

Fantastic! Thanks @ThisIsMissEm @yangshun

[ThisIsMissEm]

@Nevon ha, you beat me to it; Had doing that PR to update docusaurus on my todo list for this week :D

[Nevon]

Seeing that messed up sidebar had annoyed me greatly. Thanks for taking care of it!

[ThisIsMissEm]

Ha, same here Tommy, same here 😊

On 19. Sep 2019, at 09:19, Tommy Brunn [e-mail] wrote:

Seeing that messed up sidebar had annoyed me greatly. Thanks for taking care of it!

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub, or mute the thread.