BioDrop icon indicating copy to clipboard operation
BioDrop copied to clipboard

backticks not getting rendered in Docs

Open Pradumnasaraf opened this issue 2 years ago • 6 comments

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

  • Link to Docs folder - https://github.com/EddieHubCommunity/LinkFree/tree/main/pages/docs
  • Link to the hosted site - https://linkfree.eddiehub.io/docs

Screenshots

Screenshot 2023-01-01 at 3 49 46 PM

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

Pradumnasaraf avatar Jan 01 '23 11:01 Pradumnasaraf

It's great having you contribute to this project

Welcome to the community :nerd_face:

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.

github-actions[bot] avatar Jan 01 '23 11:01 github-actions[bot]

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.

dan-mba avatar Jan 01 '23 12:01 dan-mba

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 avatar Jan 01 '23 13:01 eddiejaoude

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 :)

AldrinSeanPereira avatar Jan 01 '23 13:01 AldrinSeanPereira

@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}]

dan-mba avatar Jan 01 '23 14:01 dan-mba

alright. thank you !!

AldrinSeanPereira avatar Jan 01 '23 14:01 AldrinSeanPereira