gatsby-theme-carbon icon indicating copy to clipboard operation
gatsby-theme-carbon copied to clipboard

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

Open yumeforever opened this issue 3 years ago • 0 comments

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 avatar Jul 14 '22 16:07 yumeforever