# easy-crooked

> JavaScript library for converting HTML into Markdown

Latest version **1.5.1** (published 2021-09-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install easy-crooked
pnpm add easy-crooked
yarn add easy-crooked
bun add easy-crooked
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.1 |
| Published | 2021-09-01 |
| First published | 2021-04-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 20.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ivan Khanevich |
| Maintainers | iamkhan21 |
| Keywords | converter, html, markdown, md |

## Links

- npm: https://www.npmjs.com/package/easy-crooked
- Repository: https://github.com/iamkhan21/easy-crooked
- Homepage: https://github.com/iamkhan21/easy-crooked#readme
- Issues: https://github.com/iamkhan21/easy-crooked/issues
- npm.io page: https://npm.io/package/easy-crooked

## Dependencies (1)

- [html-dom-parser](https://npm.io/package/html-dom-parser.md) ^1.0.1

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.5.1 (latest) — 2021-09-01
- 1.5.0 — 2021-04-11
- 1.4.0 — 2021-04-08
- 1.3.0 — 2021-04-07
- 1.2.0 — 2021-04-07
- 1.1.0 — 2021-04-07
- 1.0.0 — 2021-04-06

## README

# easy-crooked (under development) | [demo](https://easy-crooked.netlify.app/)

**easy-crooked** is a JavaScript library for converting HTML into Markdown.

![npm](https://img.shields.io/npm/v/easy-crooked)
[![minizipped size](https://badgen.net/bundlephobia/minzip/easy-crooked)](https://bundlephobia.com/result?p=easy-crooked)
[![Tests](https://github.com/iamkhan21/easy-crooked/workflows/CI/badge.svg)](https://github.com/iamkhan21/easy-crooked/actions)
[![codecov](https://codecov.io/gh/iamkhan21/easy-crooked/branch/master/graph/badge.svg)](https://codecov.io/gh/iamkhan21/easy-crooked)
[![GitHub license](https://img.shields.io/github/license/iamkhan21/easy-crooked?style=flat)](https://github.com/iamkhan21/easy-crooked/blob/master/LICENSE)

- [Installation](#installation)
- [Usage](#usage)
- [TODO](#todo)

---

## Installation

Install using the package manager for your desired environment(s):

```bash
npm install easy-crooked
# OR:
yarn add easy-crooked
```

## Usage

```javascript
import parseHtmlToMarkdown from "easy-crooked";

const htmlString = `<h1>Hello Easy Crooked!</h1>`;
const markdown = parseHtmlToMarkdown(htmlString);

console.log(markdown); // # Hello Easy Crooked!
```

## TODO

### Basic Syntax

- [ ] Blockquotes (beautify nested)

### Extended Syntax

- [ ] Tables
- [ ] Nested elements

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