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

feat: Markdown support in flag description #6399

Open
ivarconr opened this issue Mar 1, 2024 · 4 comments · May be fixed by #6453
Open

feat: Markdown support in flag description #6399

ivarconr opened this issue Mar 1, 2024 · 4 comments · May be fixed by #6453

Comments

@ivarconr
Copy link
Member

ivarconr commented Mar 1, 2024

Describe the feature request

Adding support for simple syntax like bold, italic and links would help. Unsure about "heading" etc due to limited space for descriptions.

Background

Adding links to descriptions is not rendering nice.

Solution suggestions

Reuse the <Markdown> component in the rendering.

@ivarconr
Copy link
Member Author

ivarconr commented Mar 1, 2024

In the feature page:
image

Also in feature list:
image

@ivarconr
Copy link
Member Author

ivarconr commented Mar 1, 2024

The biggest challenge seems to be to add it to the "search tables" because of the highlighter code. The highlighter only support "string" and not ReactElement.

Adding highlighter when it needs to span multiple Nodes does not seem super-intuitive.

@ivarconr
Copy link
Member Author

ivarconr commented Mar 1, 2024

I think we can do the highlight inside of the markdown component as a customer renderer.
remarkjs/react-markdown#218

@ivarconr
Copy link
Member Author

ivarconr commented Mar 4, 2024

I think we can do the highlight inside of the markdown component as a customer renderer.
remarkjs/react-markdown#218

After thinking a bit more on this I am not sure if it really makes sense to allow markdown in the descriptions when it is in table view. This will lead to a messy table that can be hard to read. The built-in description pop-over can still be rendered as markdown.

Instead the in-cell descriptions should be rendered as readable text.

Example input:

*some* text here [link](http://somewhere.com)

Example output:

some text here link

@ivarconr ivarconr linked a pull request Mar 6, 2024 that will close this issue
@ivarconr ivarconr self-assigned this Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: For later
Development

Successfully merging a pull request may close this issue.

2 participants