项目推荐：html-to-md - 支持将网页 html 节点转换为 markdown

成都程序员晴小篆 05-30 145

前言：

眼前小伙伴们对“html转md”大致比较关切，兄弟们都想要剖析一些“html转md”的相关文章。那么小编同时在网上搜集了一些关于“html转md””的相关资讯，希望同学们能喜欢，小伙伴们一起来了解一下吧！

项目链接地址：

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

可以获取任意的网页内容转为 markdown 之后保存在自己的仓库

特点快速，小巧，无任何依赖，gzip 10kb支持nodeJS，参数(html 文本)为字符串200+单元测试和模块测试，覆盖率97%

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

效果

live-demo：

使用说明安装

npm -i html-to-md

使用

const html2md = require('html-to-md')// or if you're using ES6import html2md from 'html-to-md'console.log(  html2md('<strong><em>strong and italic</em></strong>', options, force))// ***strong and italic***

参数(可选)：options:

名称

数据类型

默认值

说明

skipTags

Array

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

需要忽略的标签名

emptyTags

Array

[]

不仅忽略它本身，它内部所有标签名全部忽略

ignoreTags

Array

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

忽视标签及其内部所有内容

aliasTags

Object

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

为标签定义一个别名(通常作用于一些不常用标签)

renderCustomTags

Boolean

| 'SKIP'

| 'EMPTY'

| 'IGNORE'

true

自定义当前标签部分属性配置

tagListener

Function

(props: TagListenerProps): TagListenerReturnProps => props

定义是否渲染自定义标签（非HTML标签），

true：渲染false | SKIP：添加至skipTagsEMPTY：添加至emptyTagsIGNORE：添加至ignoreTags

优先权：skipTags > emptyTags > ignoreTags > aliasTags

例：

html2md('<><b><i>abc</i></b></>', { ignoreTags: [''] })// ''html2md('<><b><i>abc</i></b></>', { skipTags: [''] })// ***abc***html2md('<><b><i>abc</i></b></>', { emptyTags: [''] })// abchtml2md('<><b><i>abc</i></b></>', {  skipTags: [''],  aliasTags: { b: 'ul', i: 'li' },})// *  abchtml2md('<test><b><i>abc</i></b></test>', { renderCustomTags: 'SKIP' })// ***abc***

force(Boolean)(默认 false)

值

说明

true

表示强制使用自定义配置

false

对自定义配置使用Object.assign操作

例：

// 默认 skipTags 为 ['div','html','body']// 配置一：html2md('<div><b><i>abc</i></b></div>', { skipTags: ['b'] }, false)// skipTags 为 ['div','html','body','b']// 配置二：html2md('<div><b><i>abc</i></b></div>', { skipTags: ['b'] }, true)// 经过配置后 skipTags 为 ['b']

TagListenerProps

key

说明

parentTag

父标签名，没有则为null

prevTagName

上一个标签名，没有则为null

nextTagName

下一个标签名，没有则为null

isFirstSubTag

是否当前父标签内部的第一个子标签

attrs