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

Markdown tables are rendered as raw text in READMEs #789

Open
CragglesG opened this issue Nov 16, 2024 · 4 comments
Open

Markdown tables are rendered as raw text in READMEs #789

CragglesG opened this issue Nov 16, 2024 · 4 comments

Comments

@CragglesG
Copy link
Member

CragglesG commented Nov 16, 2024

No description provided.

@CragglesG CragglesG changed the title Markdown tables are not rendered in READMEs Markdown tables are rendered as raw text in READMEs Nov 17, 2024
@Gitstar-OC
Copy link
Contributor

@CragglesG could you provide more information, screenshot or a video so I can fix that ?

@CragglesG
Copy link
Member Author

Sure, here’s an example:

The README of this project contains the below table:

Long Flag Short Flag Description
--slack-token -s Set the Slack bot token
--openai-token -o Set the OpenAI token
--request-url -r Set the OpenAI request URL
--tokens -t Set the maximum number of output tokens
--num-messages -n Set the number of messages to summarize
--channels-refill -c Refill the channel list (may take a long time)

This should be rendered as above, but instead it’s rendered as raw text, like below:

Image

@Gitstar-OC
Copy link
Contributor

Will see what can be done.

@maxwofford
Copy link
Member

Nice! @CragglesG wanna submit a PR? Here's the call to ReactMarkdown!

<ReactMarkdown
components={markdownComponents}
rehypePlugins={[rehypeRaw]}
>
{readmeText}
</ReactMarkdown>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants