https://github.com/shop3/polaris-markdown

Polaris markdown component ready to use in Shopify applications.
https://github.com/shop3/polaris-markdown

markdown polaris react shopify

Last synced: 10 days ago
JSON representation

Polaris markdown component ready to use in Shopify applications.

• Host: GitHub
• URL: https://github.com/shop3/polaris-markdown
• Owner: shop3
• License: mit
• Created: 2022-05-05T11:16:58.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-29T07:50:31.000Z (over 1 year ago)
• Last Synced: 2024-08-09T13:26:55.407Z (5 months ago)
• Topics: markdown, polaris, react, shopify
• Language: JavaScript
• Homepage: https://shop3.github.io/polaris-markdown
• Size: 11.5 MB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Shop3 Polaris Markdown

Polaris markdown component ready to use in Shopify applications.

## Installation

```bash

npm install --save @shop3/polaris-markdown

```

## Usage

```js

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

// import css

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

const Page = () => {

    return (

        

            {/* markdown content */}

        

    )

}

```

## Storybook

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

# Development

## Installation

```bash

npm install

npm run husky:install

```

## Development

```bash

npm run develop

```