Skip to content

shop3/polaris-markdown

Repository files navigation

Shop3 Polaris Markdown

Polaris markdown component ready to use in Shopify applications.

Installation

npm install --save @shop3/polaris-markdown

Usage

import PolarisMarkdown from '@shop3/polaris-markdown';

// import css
import '@shop3/polaris-markdown/styles/markdown.css';

const Page = () => {
    return (
        <PolarisMarkdown>
            {/* markdown content */}
        </PolarisMarkdown>
    )
}

Storybook

Components are documented in Storybook at https://shop3.github.io/polaris-markdown/

Development

Installation

npm install

npm run husky:install

Development

npm run develop