fix: make referenced links work with code block tabs #1249
Conversation
- The reason is that the previous Codeblock implementation separates the tabs, the markdown before tabs, and the markdown after tabs into separate Remarkable component, thus they don't share information regarding the reference link - To solve this, change the Doc implementation so that one Doc have only one Remarkable component by transforming the codeblock into html string and add it as part of the markdown, letting the Remarkable take care of the html string - However, this approach made us need to ensure that there is no newline in the codetab, otherwise, the formatting inside the code will be broken. Thus, I replace every newline inside the code tag with a br tag Fix facebook#1215
|
Deploy preview for docusaurus-preview ready! Built with commit 9f4a528 |
|
Deploy preview for docusaurus-preview ready! Built with commit afdfb89 |
yangshun
changed the title
|
Thanks for the quick fix @fiennyangeln! Now that I think about it, I think this feature should be implemented as a markdown plugin that has access to the markdown AST instead of us doing our own parsing so that we don't run into similar problems again. I suspect we might have other problems surfaced in future due to this approach as there are so many Markdown syntax that we have to beware of. If you have time and are up for a challenge you can try converting this feature into a remarkable plugin 😄 |
@yangshun Are you thinking this for v2? Or a major update for v1? |
|
In v2 we'll definitely write this as a Markdown plugin, but I think that logic can be reused, so if we write it in v1 now we can also use it in v2, and vice versa. |
|
I saw remarkable-codegroup which does similar thing, however, it requires jQuery and bootstrap3 |
Motivation
the tabs, the markdown before tabs, and the markdown after tabs into
separate Remarkable component, thus they don't share information
regarding the reference link
have only one Remarkable component by transforming the codeblock
into html string and add it as part of the markdown, letting the
Remarkable take care of the html string
newline in the codetab, otherwise, the formatting inside the
code will be broken. Thus, I replace every newline inside the
code tag with a br tag
Fix #1215
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Create a referenced link with the reference located separately (one above the Codeblock tab, one below the Codeblock tab), e.g:
[You can use numbers for reference-style link definitions][1]anywhere above the Codeblock tab[1]: http://slashdot.organywhere below the Codeblock tabRelated PRs
None