https://github.com/iamkhan21/easy-crooked

JavaScript library for converting HTML to Markdown
https://github.com/iamkhan21/easy-crooked

Last synced: about 1 month ago
JSON representation

JavaScript library for converting HTML to Markdown

• Host: GitHub
• URL: https://github.com/iamkhan21/easy-crooked
• Owner: iamkhan21
• License: mit
• Created: 2021-04-05T18:31:27.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-11-20T16:38:06.000Z (about 2 years ago)
• Last Synced: 2024-08-09T21:09:48.298Z (5 months ago)
• Language: JavaScript
• Size: 1.65 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

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 = `
Hello Easy Crooked!
`;

const markdown = parseHtmlToMarkdown(htmlString);


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

```

## TODO

### Basic Syntax

- [ ] Blockquotes (beautify nested)

### Extended Syntax

- [ ] Tables

- [ ] Nested elements