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(markdownToHTML): adds full markdown support #2715

Merged
merged 17 commits into from
Jun 12, 2020
Merged

feat(markdownToHTML): adds full markdown support #2715

merged 17 commits into from
Jun 12, 2020

Conversation

kennylam
Copy link
Member

@kennylam kennylam commented Jun 10, 2020

Related Ticket(s)

Fixes #2551

Description

This adds full markdown support to content. While all markdown syntax is supported, not all css styles are included and will be added as needed, as well as any attributes required (class, aria, etc). These can be added to the custom renderer in the utility.

Current syntaxes supported are:

  • italics
  • bold
  • paragraphs
  • ordered/unordered lists
  • anchor links

Example link and list here.

Changelog

New

  • Marked package for full markdown support
  • DOMPurify package to sanitize output (dangerouslySetInnerHTML)
  • css styling for ordered/unordered lists
  • add prop blocks to LocaleModalCountries

Changed

  • updated Storybook content

Removed

  • custom regex for bold, italic, paragraphs

@kennylam kennylam added the package: react Work necessary for the Carbon for IBM.com react components package label Jun 10, 2020
@jeffchew
Copy link
Member

@kennylam do we have to worry about inverse here for the list items?

Screen Shot 2020-06-11 at 4 36 07 PM

Copy link
Member

@jeffchew jeffchew left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This pretty much looks good, but just had a question about the inverse handling of the list items.

@kennylam
Copy link
Member Author

@kennylam do we have to worry about inverse here for the list items?

@jeffchew looks like this got resolved in #2735

@ibmdotcom-bot
Copy link
Contributor

@kennylam
Copy link
Member Author

GH test integration build errors fixed in #2740

@kennylam kennylam merged commit 41ebf6f into carbon-design-system:master Jun 12, 2020
@kennylam kennylam deleted the feat/markdown-full-md branch June 30, 2020 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: react Work necessary for the Carbon for IBM.com react components package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change the Markdown utility based on the recent Reboot Learn template designs
3 participants