<commit_before># meact

> Customizable Markdown React renderer

[![Travis](https://img.shields.io/travis/gakimball/meact.svg?maxAge=2592000)](https://travis-ci.org/gakimball/meact) [![npm](https://img.shields.io/npm/v/meact.svg?maxAge=2592000)](https://www.npmjs.com/package/meact)

## Installation

```bash
npm install meact
```

## Usage

```jsx
import Markdown from 'meact';

text = `
# Zombo.com

Welcome to [Zombo.com](http://zombo.com). This is Zombo.com. Welcome. This is Zombo.com. Welcome to Zombo.com. You can do anything at Zombo.com. Anything at all. The only limit is yourself. Welcome to Zombo.com. Welcome to Zombo.com. This is Zombo.com. Welcome to Zombo.com. This is Zombo.com, welcome!

Yes, this is Zombo.com. This is Zombo.com, and welcome to you who have come to Zombo.com. Anything is possible at Zombo.com. You can do anything at Zombo.com. The infinite is possible is Zombo.com. The unattainable is unknown at Zombo.com. Welcome to Zombo.com. This is Zombo.com. Welcome to Zombo.com. Welcome. This is Zombo.com. Welcome to Zombo.com! Welcome to Zombo.com.
`;

<Markdown input={text} />
```

If you're not using a module loader, in the browser you can access the Markdown component on `window.meact.default`.

## Supported features

- [x] Blockquotes
- [x] Bulleted Lists
- [x] Code
- [x] Dividers
- [x] Emphasis
- [x] Fences
- [x] Headings
- [x] Images
- [x] Links
- [x] Ordered Lists
- [x] Paragraphs
- [x] Line Breaks
- [x] Strong
- [ ] Reference Links
- [ ] HTML
- [ ] Tables
- [ ] Syntax Highlighting
- [x] Strikethrough

## Local Development

```bash
git clone https://github.com/gakimball/meact
cd meact
npm install
npm test
```

## License

MIT &copy; [<NAME>](http://geoffkimball.com)<commit_msg>Add more usage info to readme<commit_after># meact

> Customizable Markdown React renderer

[![Travis](https://img.shields.io/travis/gakimball/meact.svg?maxAge=2592000)](https://travis-ci.org/gakimball/meact) [![npm](https://img.shields.io/npm/v/meact.svg?maxAge=2592000)](https://www.npmjs.com/package/meact)

## Installation

```bash
npm install meact
```

## Usage

```jsx
import Markdown from 'meact';

text = `
# Zombo.com

Welcome to [Zombo.com](http://zombo.com). This is Zombo.com. Welcome. This is Zombo.com. Welcome to Zombo.com. You can do anything at Zombo.com. Anything at all. The only limit is yourself. Welcome to Zombo.com. Welcome to Zombo.com. This is Zombo.com. Welcome to Zombo.com. This is Zombo.com, welcome!

Yes, this is Zombo.com. This is Zombo.com, and welcome to you who have come to Zombo.com. Anything is possible at Zombo.com. You can do anything at Zombo.com. The infinite is possible is Zombo.com. The unattainable is unknown at Zombo.com. Welcome to Zombo.com. This is Zombo.com. Welcome to Zombo.com. Welcome. This is Zombo.com. Welcome to Zombo.com! Welcome to Zombo.com.
`;

<Markdown input={text} />
```

If you're not using a module loader, in the browser you can access the Markdown component on `window.meact.default`.

## Customization

You can pass in a custom instance of markdown-it to the `<Markdown />` component.

```jsx
import markdownIt from 'markdown-it';
import emoji from 'markdown-it-emoji';

const renderer = markdownIt().use(emoji);

<Markdown renderer={renderer} />
```

## Feature Support

All of markdown-it's built-in features will render as React-based HTML. Plugins should work, but haven't been tested yet.

Features known not to work include:
  - Reference links

Features that are wonky:
  - List items have `<p>` elements inside them, even if the item is one line of text.

## Local Development

```bash
git clone https://github.com/gakimball/meact
cd meact
npm install
npm test
```

## License

MIT &copy; [<NAME>](http://geoffkimball.com)
{'fraction_non_alphanumeric': 0.12935190144617031, 'fraction_numerical': 0.007498660953401178, 'mean_word_length': 3.9339498018494057, 'pattern_counts': {'":': 0, '<': 10, '<?xml version=': 0, '>': 12, 'https://': 10, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1609103', 'n_tokens_mistral': 1400, 'n_tokens_neox': 1327, 'n_words': 435}