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

Allow caption="" props to display markdown text decoration, code and link #1253

Open
4 tasks
yumeforever opened this issue Jul 14, 2022 · 0 comments
Open
4 tasks

Comments

@yumeforever
Copy link

yumeforever commented Jul 14, 2022

Summary

caption="" props like the one in DoDont) don't allow any markdown features needed to highlight text. This is limiting and doesn't take away from a caption component use.

Justification

My current use case is the following:

  • Add token names as descriptions to images in do-don't examples
  • Highlight a word with bold or italic
  • Add a read more type of link to a caption

Examples

Ps: The text/content of the examples is being worked on, just check for the style not the content.

CleanShot 2022-07-14 at 18 55 34@2x

CleanShot 2022-07-14 at 18 56 00@2x

Desired UX and success metrics

The user is able to use a markdown inside a caption to highlight text (bold, italic, link and inline code)

Must-have functionality

Caption functionalities should be able to allow markdown for:

  • italic
  • bold
  • 'code'
  • link

Specific timeline issues / requests

Whenever possible, not a blocker.

@yumeforever yumeforever changed the title Allow Captions to display markdown text decoration, code and link Allow caption="" props to display markdown text decoration, code and link Jul 14, 2022
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

1 participant