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

Single backtick is recognised as Codeblock #2188

Closed
akshatnema opened this issue Sep 30, 2023 · 9 comments · Fixed by #2208
Closed

Single backtick is recognised as Codeblock #2188

akshatnema opened this issue Sep 30, 2023 · 9 comments · Fixed by #2208
Labels
bug good first issue Good for newcomers Hacktoberfest Label issues as available for participants of https://hacktoberfest.digitalocean.com

Comments

@akshatnema
Copy link
Member

akshatnema commented Sep 30, 2023

Describe the bug

Inside case studies, the block of text that is under single backticks is recognized as CodeBlock.

How to Reproduce

Go to https://www.asyncapi.com/casestudies/adeogroup and scroll down to the content.

Screenshots

image

Expected behavior

It should be highlighted as standard tags, inline with the content.

Reference:
image

@akshatnema akshatnema added bug Hacktoberfest Label issues as available for participants of https://hacktoberfest.digitalocean.com good first issue Good for newcomers labels Sep 30, 2023
@rohitkbc
Copy link

rohitkbc commented Sep 30, 2023

Hi @akshatnema, Can you assign this task to me? I can work on it.

@0xVikasRushi
Copy link
Contributor

@rohitkbc Are you working on this? i have done changes

@0xVikasRushi
Copy link
Contributor

0xVikasRushi commented Oct 1, 2023

I can't find exact tag to match reference highlighting Image.

  • highlighting is done by**text**
  • $ref which link should i include? @akshatnema
single-backtick

@akshatnema
Copy link
Member Author

highlighting is done bytext

You don't have to change the markdown inside the content. Instead, you should change the MDXComponent to render the backtick content properly.

@pruthuraut
Copy link

I have done the changes in case-studies.json
asncyapi

@akshatnema
Copy link
Member Author

I have done the changes in case-studies.json

It is an auto-generated file from the script. It will again get refreshed, once you rebuild the website.

@karthikmurakonda
Copy link
Contributor

Can i work on this?

@karthikmurakonda
Copy link
Contributor

karthikmurakonda commented Oct 4, 2023

@akshatnema I have looked into the issue. The content with single backtick is not treated as inlineCode as expected. I am not sure why this is happening.
I have also tried to give code component to pre.code tag as they mentioned in here. But didn't succeed.

@karthikmurakonda
Copy link
Contributor

I see that this is because of next-mdx-remote package is using MDX v2.0 which deprecated the above two methods I have tried.
So I implemented the solution mentioned here hashicorp/next-mdx-remote#244

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug good first issue Good for newcomers Hacktoberfest Label issues as available for participants of https://hacktoberfest.digitalocean.com
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants