npmpackage.info

Gathering detailed insights and metrics for html-to-md

Other packages similar to html-to-md

mammoth

1.9.1

Convert Word documents from docx to simple HTML and Markdown

md-to-pdf

5.2.4

CLI tool for converting Markdown files to PDF.

@karinjs/md-html

1.3.0

Convert Markdown text to HTML text

node-html-markdown

1.3.0

Fast HTML to markdown cross-compiler, compatible with both node and the browser

Gathering detailed insights and metrics for html-to-md

html-to-md - 0.8.8 | npmpackage.info

html-to-md

A JS library for convert HTML<String> to markdown<String>, gzip 10kb

0.8.8

142

MIT

JavaScript

483.79 kB

1,321,911 2.9

Installations

npm install html-to-md

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.20.1

NPM Version

8.19.4 Pull Requests

Open

1

Total

48

Closed

27

Merged

20

Issues

Open

2

Total

36

Closed

34

Releases

Unable to fetch releases

Languages

JavaScript

TypeScript

HTML

JavaScript (60.43%)

TypeScript (29.51%)

HTML (10.06%)

Developer

stonehank

Download Statistics

Total Downloads

1,321,911

Last Day

11,427

Last Week

78,272

Last Month

305,677

Last Year

820,481

GitHub Statistics

MIT License

142 Stars

196 Commits

17 Forks

1 Watchers

7 Branches

6 Contributors

Updated on Jul 18, 2025

Maintainers

View All 6 Contributors

Package Meta Information

Latest Version

0.8.8

Package Id

html-to-md@0.8.8

Unpacked Size

483.79 kB

Size

128.86 kB

File Count

118

NPM Version

8.19.4

Node Version

16.20.1

Published on

Apr 27, 2025

Total Downloads

Cumulative downloads

Total Downloads

1,321,911

Last Day

7.9%

11,427

Compared to previous day

Last Week

9.7%

78,272

Compared to previous week

Last Month

30.5%

305,677

Compared to previous month

Last Year

435.7%

820,481

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

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

npm bundle size

特点

快速，小巧，无任何依赖，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:

名称	数据类型	默认值	说明
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`	定义是否渲染自定义标签（非HTML标签）， `true`：渲染 `false \| SKIP`：添加至`skipTags` `EMPTY`：添加至`emptyTags` `IGNORE`：添加至`ignoreTags`
tagListener	Function	(tagName: String, props: TagListenerProps): TagListenerReturnProps => props	自定义当前标签部分属性配置

优先权：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)

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

例：

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

key	说明
parentTag	父标签名，没有则为 null
prevTagName	上一个标签名，没有则为 null
nextTagName	下一个标签名，没有则为 null
isFirstSubTag	是否当前父标签内部的第一个子标签
attrs	当前标签的 attributes，以 object 集合方式，例如 { src, href ... }
innerHTML	内部 HTML 字符串
match	当前的 HTML 对应 Markdown 的匹配符号
language?	当前标签语言，只在 pre 标签中出现
isSelfClosing	是否自闭和标签

TagListenerReturnProps

key	说明
attrs	当前标签的 attributes，以 object 集合方式，例如 { src, href ... }
match	返回一个新的自定义匹配符号
language?	返回自定义 pre 标签的 language

支持标签

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

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

4

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

113 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-3wcq-x3mq-6r9p
Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
Warn: Project is vulnerable to: GHSA-vh7m-p724-62c2
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
Warn: Project is vulnerable to: GHSA-6h5x-7c5m-7cr7
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-vfrc-7r7c-w9mx
Warn: Project is vulnerable to: GHSA-7wwv-vh3v-89cq
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
Warn: Project is vulnerable to: GHSA-6x33-pw7p-hmpq
Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-6vfc-qv3f-vr6c
Warn: Project is vulnerable to: GHSA-ch52-vgq2-943f
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-92xj-mqp7-vmcj
Warn: Project is vulnerable to: GHSA-wxgw-qj99-44c2
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6
Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp
Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr
Warn: Project is vulnerable to: GHSA-c9g6-9335-x697
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-9m6j-fcg5-2442
Warn: Project is vulnerable to: GHSA-hh27-ffr2-f2jc
Warn: Project is vulnerable to: GHSA-rqff-837h-mm52
Warn: Project is vulnerable to: GHSA-8v38-pw62-9cw2
Warn: Project is vulnerable to: GHSA-hgjh-723h-mx2j
Warn: Project is vulnerable to: GHSA-jf5r-8hm2-f872
Warn: Project is vulnerable to: GHSA-wr3j-pwj9-hqq6
Warn: Project is vulnerable to: GHSA-4v9v-hfq4-rm2v
Warn: Project is vulnerable to: GHSA-9jgg-88mc-972h
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

2.9

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to html-to-md

Other packages similar to html-to-md

html-to-md

Installations

Developer Guide

Yes

CommonJS

16.20.1

8.19.4

Pull Requests

1

48

27

20

Issues

2

36

34

Releases

Unable to fetch releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

1,321,911

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

特点

效果

为什么做这个工具

使用说明

安装

使用

参数(可选)：

options:

force(Boolean)(默认 false)

TagListenerProps

TagListenerReturnProps

支持标签

10

10

10

4

0

0

0

0

0

0

0

0

0

2.9

/10