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

特点

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

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

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

注意：只有有效规范的 HTML 文本才能准确显示结果，如<p>abc< ，<i>abc</>等都是无效文本

效果

live-demo

为什么做这个工具

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

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

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

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

使用说明

安装

npm -i html-to-md

使用

1const html2md = require('html-to-md')
2// or if you're using ES6
3import html2md from 'html-to-md'
4
5console.log(
6  html2md('<strong><em>strong and italic</em></strong>', options, force)
7)
8// ***strong and italic***

参数(可选)：

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

例：

1html2md('<><b><i>abc</i></b></>', { ignoreTags: [''] })
2// ''
3
4html2md('<><b><i>abc</i></b></>', { skipTags: [''] })
5// ***abc***
6
7html2md('<><b><i>abc</i></b></>', { emptyTags: [''] })
8// abc
9
10html2md('<><b><i>abc</i></b></>', {
11  skipTags: [''],
12  aliasTags: { b: 'ul', i: 'li' },
13})
14// *  abc
15
16html2md('<test><b><i>abc</i></b></test>', { renderCustomTags: 'SKIP' })
17// ***abc***

force(Boolean)(默认 false)

例：

1// 默认 skipTags 为 ['div','html','body']
2
3// 配置一：
4html2md('<div><b><i>abc</i></b></div>', { skipTags: ['b'] }, false)
5// skipTags 为 ['div','html','body','b']
6
7// 配置二：
8html2md('<div><b><i>abc</i></b></div>', { skipTags: ['b'] }, true)
9// 经过配置后 skipTags 为 ['b']

TagListenerProps

TagListenerReturnProps

支持标签

• a
• b
• blockquote
• code
• del
• em
• h1~h6
• hr
• i
• img
• input
• li
• ol
• p
• pre
• s
• strong
• table
• tbody
• td
• th
• thead
• tr
• ul