html-to-md

> 一个用于转换HTML为Markdown的工具。English

---

!npm bundle size

$3

- 快速，小巧，无任何依赖，gzip 10kb

- 支持nodeJS，参数(html 文本)为字符串

- 200+单元测试和模块测试，覆盖率97%

> 注意：只有有效规范的 HTML 文本才能准确显示结果，如

abc< ，abc等都是无效文本

$3

live-demo

$3

最初的动机是希望将leetcode-cn上的题目和自己的解答搬到github，
但是获取的介绍都是html格式文本，因此有了将html转换为markdown的需求。

找了几个工具，结果并不是很合胃口，有的不支持nodejs，有的并不能很好的转换，最终决定自己写一个来用。

刚开始只是写了一个比较简单的，但已经能够处理我的需求。

但后来偶尔一次使用，面对更复杂的html格式，就会出现混乱，这个库也就是一个重构版，
当然，它可能还存在很多bug没有发现，但希望能在后续不断完善，如果有发现bug，请提issue或PR，我会第一时间进行处理。

$3

##### 安装

npm -i html-to-md

##### 使用

``js
const html2md = require('html-to-md')
// or if you're using ES6
import html2md from 'html-to-md'

console.log(
html2md('strong and italic', options, force)
)
// strong and italic
`

$3

#### options:

[
  'div',
  'html',
  'body',
  'nav',
  'section',
  'footer',
  'main',
  'aside',
  'article',
  'header'
]

[
  '',
  'style',
  'head',
  '!doctype',
  'form',
  'svg',
  'noscript',
  'script',
  'meta'
]

{
  figure :'p',
  figcaption:'p',
  dl:'p', 
  dd:'p', 
  dt:'p'
}

> 优先权：skipTags > emptyTags > ignoreTags > aliasTags

例：

`javascript
html2md('<>abc', { ignoreTags: [''] })
// ''

html2md('<>abc', { skipTags: [''] })
// abc

html2md('<>abc', { emptyTags: [''] })
// abc

html2md('<>abc', {
skipTags: [''],
aliasTags: { b: 'ul', i: 'li' },
})
// * abc

html2md('abc', { renderCustomTags: 'SKIP' })
// abc
`

#### force(Boolean)(默认 false)

| 值 | 说明 |
| :---: | :---------------------------------: |
| true | 表示强制使用自定义配置 |
| false | 对自定义配置使用Object.assign操作 |

例：

`javascript
// 默认 skipTags 为 ['div','html','body']

// 配置一：
html2md('