⚠️This version of Waffles Design System is no longer maintained, and was deprecated at the end of 2022. It's main repository is archived. Please migrate your app to the New Waffles.

components

Markdown

A component to render markdown.

Overview

A component to render markdown using the styles of this design system. Note this is an initial version of this component and so is limited in its functionality. This documentation is also minimal, so if you are intending to use this component, please contact the design system squad for assistance.

import Markdown from '@datacamp/waffles-markdown';

function Playground(): JSX.Element {
  return (
    <Markdown
      source={`
### Example heading
This is some content
  `}
    />
  );
}

import Markdown from '@datacamp/waffles-markdown';

function Playground(): JSX.Element {
  return (
    <Markdown
      source={`
### Example heading
This is some content
  `}
    />
  );
}

Live

Props

Markdown

Name	Value	Default	Description
className	string		Adds a css className to the rendered element.
source	string	Required	The markdown string to render.

Imports

You can import following components or utilities from this module:

import Markdown from '@datacamp/waffles-markdown';