# mfm-parser-pegjs

> A MFM parser implementation with PEG.js

Latest version **0.4.0** (published 2021-03-18) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install mfm-parser-pegjs
pnpm add mfm-parser-pegjs
yarn add mfm-parser-pegjs
bun add mfm-parser-pegjs
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2021-03-18 |
| First published | 2020-02-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 107.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Marihachi |
| Maintainers | syuilo, marihachi |

## Links

- npm: https://www.npmjs.com/package/mfm-parser-pegjs
- Repository: https://github.com/marihachi/mfm-parser-pegjs
- Homepage: https://github.com/marihachi/mfm-parser-pegjs#readme
- Issues: https://github.com/marihachi/mfm-parser-pegjs/issues
- npm.io page: https://npm.io/package/mfm-parser-pegjs

## Dependencies (1)

- [twemoji-parser](https://npm.io/package/twemoji-parser.md) 13.0.x

## Recent versions

- 0.4.0 (latest) — 2021-03-18
- 0.3.0 — 2021-03-17
- 0.2.0 — 2020-02-24
- 0.1.3 — 2020-02-24
- 0.1.2 — 2020-02-24
- 0.1.1 — 2020-02-23
- 0.1.0 — 2020-02-23

## README

# mfm-parser-pegjs
## Description
A MFM parser implementation with PEG.js (In developing)  

## Installation
```
npm i mfm-parser-pegjs
```

## Usage
TypeScript:  
```ts
import * as mfm from 'mfm-parser-pegjs';

// parse a MFM text
const result = mfm.parse('good morning ***everynyan!***');

// parse a MFM plain text
const plainResult = mfm.parsePlain('I like the hot soup :soup:​');
```

## Usage (Repository)
### 1. Clone
```
git clone https://github.com/marihachi/mfm-parser-pegjs.git
```

### 2. Install packages
```
cd mfm-parser-pegjs
npm i
```

### 3. Build
```
npm run build
```

### Use the interactive CLI parser
```
npm run parse
```

## License
This software is released under the [MIT License](LICENSE).

---
_Source: https://npm.io/package/mfm-parser-pegjs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._