Example of Markdown - default
React documentation
Last modified:
ℹ️ This feature doesn’t have a corresponding React component yet.
It may not receive one as it is merely a styling wrapper for parsed Markdown that’s been turned into HTML.
HTML
Last modified:
Use a Markdown parser appropriate for your stack.
Let the Markdown parser turn into semantic content HTML elements.
Then simply wrap the content with an appropriate wrapper element with the .bc-markdown
CSS class.
Recommended Markdown parsers
- Redcarpet (Ruby)
- Kramdown (Ruby)
- Kramdown GFM parser (Ruby)
- Our Design System website supports adding third-party Remark and Rehype plugins for Markdown and MDX. (Astro)
Please see if one has already been standardized to avoid new dependencies.
Design
Last modified:
The following variants are available:
Variant | Purpose |
---|---|
.bc-markdown--bordered | Used for MD comments shown in an Activity feed. |
.bc-markdown--private | Used for MD comments visible only between 2 users. |
.bc-markdown--bugcrowd-internal | Used for MD comments only visible to the Bugcrowd team. |
Accessibility
Last modified:
Let users know when a <textarea>
supports Markdown.
Give users a cheat sheet and link(s) to authoritative Markdown resources — eg. see the Platform’s <MarkdownSupportedModal>
.
Rationale
Last modified:
This module exists to style Markdown content, most notably user-provided content, eg. comments.
It is analogous to CSS ‘theme’ styling for Markdown content, eg. GitHub-Flavored Markdown’s CSS.
It exists to extend and differentiate content styles from those provided by .bc-body
.
See also
Last modified: