Search/

Markdown

Last modified:

A wrapper for styling rendered Markdown (MD).

The Markdown example and test file is adapted from John Gruber’s Markdown Syntax page.

Example of Markdown - default

Unable to render haml example.
[object Promise]

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.

Please see if one has already been standardized to avoid new dependencies.

Design

Last modified:

The following variants are available:

VariantPurpose
.bc-markdown--borderedUsed for MD comments shown in an Activity feed.
.bc-markdown--privateUsed for MD comments visible only between 2 users.
.bc-markdown--bugcrowd-internalUsed 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: