https://github.com/platzidev/react-markdown

React component to parse and render Platzi Flavored Markdown content
https://github.com/platzidev/react-markdown

javascript markdown npm parse react react-component

Last synced: 3 days ago
JSON representation

React component to parse and render Platzi Flavored Markdown content

• Host: GitHub
• URL: https://github.com/platzidev/react-markdown
• Owner: PlatziDev
• License: mit
• Created: 2017-01-13T06:37:43.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-11-28T02:47:53.000Z (12 months ago)
• Last Synced: 2024-09-18T02:05:25.297Z (about 2 months ago)
• Topics: javascript, markdown, npm, parse, react, react-component
• Language: JavaScript
• Size: 86.9 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-markdown

React component to parse and render Platzi Flavored Markdown content

This component made use of [@platzi/markdown](https://github.com/PlatziDev/markdown) to render a content using markdown in a React application.

## Usage

Install it with:

```bash

npm i -S react @platzi/react-markdown

```

Import it with:

```js

import React from 'react';

import Markdown from '@platzi/react-markdown';

function App() {

  return (

    

  );

}

```

- You cand send any native DOM attribute to the Markdown component.

- The default `tagName` is a `div`.

- The value of `parser` is an empty object by default.

- The `content` is required.

## Run test

You have 4 ways to run tests.

- `npm t`: run the test once

- `npm run test:fix`: run the test and fix the snapshots

- `npm run test:watch`: run the test and keep watching changes

- `npm run test:report`: run test and generate a coverage report