Skip to content
This repository has been archived by the owner on Aug 7, 2024. It is now read-only.

backticks not getting rendered in Docs #2562

Closed
Pradumnasaraf opened this issue Jan 1, 2023 · 6 comments · Fixed by #2566
Closed

backticks not getting rendered in Docs #2562

Pradumnasaraf opened this issue Jan 1, 2023 · 6 comments · Fixed by #2566
Assignees

Comments

@Pradumnasaraf
Copy link
Contributor

Pradumnasaraf commented Jan 1, 2023

Description

On the website, the backticks are not getting rendered. It's bolding just bolding up the text.

It should look something like sample-text

Screenshots

Screenshot 2023-01-01 at 3 49 46 PM

Above Screenshot hosted link - https://linkfree.eddiehub.io/docs/contributing/hacktoberfest

@Pradumnasaraf Pradumnasaraf added the 🛠 goal: fix undefined label Jan 1, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jan 1, 2023

It's great having you contribute to this project

Welcome to the community 🤓

If you would like to continue contributing to open source and would like to do it with an awesome inclusive community, you should join our Discord chat and our GitHub Organisation - we help and encourage each other to contribute to open source little and often 🤓 . Any questions let us know.

@dan-mba
Copy link
Member

dan-mba commented Jan 1, 2023

I think this is related to the configuration of remark-prism which is done in next.config.mjs.

There is an option for it to handle inline code, but it is off by default.

@eddiejaoude
Copy link
Member

Thanks for raising Pradumna 👍

There is an option for it to handle inline code, but it is off by default.

oh I see, thank you Dan, great spot 💯

Maybe a good first issue for someone

@eddiejaoude eddiejaoude added the good first issue undefined label Jan 1, 2023
@AldrinSeanPereira
Copy link
Member

I'd like to take up this bug.

I referred to the links given by @dan-mba but I'm stuck at finding what needs to be fixed ... may need to spend more time (or not)

any advice would be appreciated :)

@dan-mba
Copy link
Member

dan-mba commented Jan 1, 2023

@AldrinSeanPereira the format of the plugins for @next/mdx isn't well documented, but it links to this MDX documentation.

I think remarkPrism needs to be changed to [remarkPrism, {transformInlineCode: true}]

@AldrinSeanPereira
Copy link
Member

alright. thank you !!

AldrinSeanPereira added a commit to AldrinSeanPereira/LinkFree that referenced this issue Jan 1, 2023
this fix is for issue EddieHubCommunity#2562 where I have set transformInLineCode to true
@Panquesito7 Panquesito7 added the 📄 aspect: text undefined label Jan 1, 2023
@schmelto schmelto mentioned this issue Jan 23, 2023
eddiejaoude pushed a commit that referenced this issue Jan 23, 2023
* issue #2562 fix

this fix is for issue #2562 where I have set transformInLineCode to true

* Update globals.css

* Update next.config.mjs

Co-authored-by: Tom Schmelzer <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
5 participants