, gzip 10kb","maintainers":[{"name":"stonehank","email":"stonehank310@gmail.com"}],"readme":"> 一个用于转换`HTML`为`Markdown`的工具。[English](./README-EN.md)\n\n---\n\n[](https://travis-ci.org/stonehank/html-to-md)\n[](https://www.npmjs.com/package/html-to-md)\n[](https://codecov.io/gh/stonehank/html-to-md)\n\n\n\n### 特点\n\n- 快速，小巧，无任何依赖，`gzip` 10kb\n\n- 支持`nodeJS`，参数(html 文本)为字符串\n\n- 200+单元测试和模块测试，覆盖率`97%`\n\n> 注意：只有有效规范的 HTML 文本才能准确显示结果，如`abc<` ，`abc`等都是**无效**文本\n\n### 效果\n\n[live-demo](https://stonehank.github.io/html-to-md/)\n\n### 为什么做这个工具\n\n最初的动机是希望将`leetcode-cn`上的题目和自己的解答[搬到`github`](https://github.com/stonehank/leetcode-solution-js)，\n但是获取的介绍都是`html`格式文本，因此有了将`html`转换为`markdown`的需求。\n\n找了几个工具，结果并不是很合胃口，有的不支持`nodejs`，有的并不能很好的转换，最终决定自己写一个来用。\n\n刚开始只是写了一个比较简单的，但已经能够处理我的需求。\n\n但后来偶尔一次使用，面对更复杂的`html`格式，就会出现混乱，这个库也就是一个重构版，\n当然，它可能还存在很多`bug`没有发现，但希望能在后续不断完善，如果有发现`bug`，请提`issue`或`PR`，我会第一时间进行处理。\n\n### 使用说明\n\n##### 安装\n\n`npm -i html-to-md`\n\n##### 使用\n\n```js\nconst html2md = require('html-to-md')\n// or if you're using ES6\nimport html2md from 'html-to-md'\n\nconsole.log(\n html2md('strong and italic', options, force)\n)\n// ***strong and italic***\n```\n\n### 参数(可选)：\n\n#### options:\n\n\n\n\n| 名称 | \n数据类型 | \n默认值 | \n说明 | \n
\n\n\n\n| skipTags | \nArray | \n\n[\n 'div',\n 'html',\n 'body',\n 'nav',\n 'section',\n 'footer',\n 'main',\n 'aside',\n 'article',\n 'header'\n] | \n需要忽略的标签名 | \n
\n\n| emptyTags | \nArray | \n[] | \n不仅忽略它本身，它内部所有标签名全部忽略 | \n
\n\n| ignoreTags | \nArray | \n\n\n[\n '',\n 'style',\n 'head',\n '!doctype',\n 'form',\n 'svg',\n 'noscript',\n 'script',\n 'meta'\n] | \n忽视标签及其内部所有内容 | \n
\n\n| aliasTags | \nObject | \n\n \n{\n figure :'p',\n figcaption:'p',\n dl:'p', \n dd:'p', \n dt:'p'\n} | \n为标签定义一个别名(通常作用于一些不常用标签) | \n
\n\n| renderCustomTags | \n Boolean
|'SKIP'
|'EMPTY'
|'IGNORE' | \n\ntrue | \n定义是否渲染自定义标签（非HTML标签），\n\ntrue：渲染false | SKIP：添加至skipTagsEMPTY：添加至emptyTagsIGNORE：添加至ignoreTags \n | \n
\n\n| tagListener | \nFunction | \n\n(tagName: String, props: TagListenerProps): TagListenerReturnProps => props\n | \n自定义当前标签部分属性配置 | \n
\n\n
\n\n> 优先权：skipTags > emptyTags > ignoreTags > aliasTags\n\n例：\n\n```javascript\nhtml2md('<>abc', { ignoreTags: [''] })\n// ''\n\nhtml2md('<>abc', { skipTags: [''] })\n// ***abc***\n\nhtml2md('<>abc', { emptyTags: [''] })\n// abc\n\nhtml2md('<>abc', {\n skipTags: [''],\n aliasTags: { b: 'ul', i: 'li' },\n})\n// * abc\n\nhtml2md('abc', { renderCustomTags: 'SKIP' })\n// ***abc***\n```\n\n#### force(Boolean)(默认 false)\n\n| 值 | 说明 |\n| :---: | :---------------------------------: |\n| true | 表示强制使用自定义配置 |\n| false | 对自定义配置使用`Object.assign`操作 |\n\n例：\n\n```javascript\n// 默认 skipTags 为 ['div','html','body']\n\n// 配置一：\nhtml2md('
abc
', { skipTags: ['b'] }, false)\n// skipTags 为 ['div','html','body','b']\n\n// 配置二：\nhtml2md('abc
', { skipTags: ['b'] }, true)\n// 经过配置后 skipTags 为 ['b']\n```\n\n#### TagListenerProps\n\n| key | 说明 |\n| ------------- | ----------------------------------------------------------------- |\n| parentTag | 父标签名，没有则为 null |\n| prevTagName | 上一个标签名，没有则为 null |\n| nextTagName | 下一个标签名，没有则为 null |\n| isFirstSubTag | 是否当前父标签内部的第一个子标签 |\n| attrs | 当前标签的 attributes，以 object 集合方式，例如 { src, href ... } |\n| innerHTML | 内部 HTML 字符串 |\n| match | 当前的 HTML 对应 Markdown 的匹配符号 |\n| language? | 当前标签语言，只在 pre 标签中出现 |\n| isSelfClosing | 是否自闭和标签 |\n\n#### TagListenerReturnProps\n\n| key | 说明 |\n| --------- | ----------------------------------------------------------------- |\n| attrs | 当前标签的 attributes，以 object 集合方式，例如 { src, href ... } |\n| match | 返回一个新的自定义匹配符号 |\n| language? | 返回自定义 pre 标签的 language |\n\n### 支持标签\n\n- `a`\n- `b`\n- `blockquote`\n- `code`\n- `del`\n- `em`\n- `h1~h6`\n- `hr`\n- `i`\n- `img`\n- `input`\n- `li`\n- `ol`\n- `p`\n- `pre`\n- `s`\n- `strong`\n- `table`\n- `tbody`\n- `td`\n- `th`\n- `thead`\n- `tr`\n- `ul`\n","readmeFilename":"README.md"}