2 Star 2 Fork 9

进击的皇虫 / html2json

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

html2json

使用Go语言开发的HTML和Markdown转JSON工具,将HTML/Markdown内容转换为符合各种小程序rich-text组件内容渲染所需格式的JSON

介绍

在开发 BookStack 的配套微信小程序 BookChat 以及使用 uni-app 开发配套的手机APP应用 BookChatApp的过程中, 我尝试了很多种开源的小程序HTML解析渲染组件,但都不是很满意。

后来将HTML内容在后端解析,并在小程序段使用自带的rich-text组件进行渲染,性能、稳定性以及渲染效果都比较符合预期,尽管并没有第三方HTML渲染工具那样提供图片预览的功能。

目前已经在BookStack v2.1 版本中使用了。

特点

  1. 支持markdown和HTML转JSON
  2. 可作为 resetful 服务提供API接口进行访问
  3. Go语言开发者,可作为包的形式进行引用

使用方式

更多使用帮助,使用如下方式查看

./html2json --help

resetful 方式使用

启动服务

./html2json serve --port 8888 --tags weixin-html-tags.json
  • --port - [非必需参数]指定服务端口,默认为 8888
  • --tags - [非必须参数]指定信任的HTML元素。json数组文件,里面存放各个支持的HTML标签。默认使用 uni-app 信任的HTML标签

各小程序支持的HTML标签

weixin-html-tags.json文件示例:

["a", "abbr", "address", "article", "aside", "b", "bdi", "bdo", "big", "blockquote", "br", "caption", "center", "cite", "code", "col", "colgroup", "dd", "del", "div", "dl", "dt", "em", "fieldset", "font", "footer", "h1", "h2", "h3", "h4", "h5", "h6", "header", "hr", "i", "img", "ins", "label", "legend", "li", "mark", "nav", "ol", "p", "pre", "q", "rt", "ruby", "s", "section", "small", "span", "strong", "sub", "sup", "table", "tbody", "td", "tfoot", "th", "thead", "tr", "tt", "u", "ul"]

API接口

解析来自url链接的HTML

请求方法

GET

请求接口

/html2json

请求参数

  • url - [必需]需要解析的内容链接。
  • timeout - 超时时间,单位为秒,默认为10秒
  • domain - 图片等静态资源域名,用于拼装图片等链接。需带 httphttps,如 https://static.bookstack.cn

注意:程序只解析 HTML 中的 Body 内容

使用示例

http://localhost:8888/html2json?timeout=5&url=https://gitee.com/truthhun/BookStack

解析Form表单提交HTML的内容

请求方法

POST

请求接口

/html2json

请求参数

  • html - HTML内容字符串
  • domain - 图片等静态资源域名,用于拼装图片等链接。需带 httphttps,如 https://static.bookstack.cn
解析form表单提交的markdown内容

请求方法

POST

请求接口

/md2json

请求参数

  • markdown - [必需] markdown内容字符串
  • domain - 图片等静态资源域名,用于拼装图片等链接。需带 httphttps,如 https://static.bookstack.cn

以包的形式引用(针对Go语言)

安装

go get -v github.com/TruthHun/html2json

使用示例

package main

import (
	"encoding/json"
	"fmt"
	"time"

	"github.com/TruthHun/html2json/html2json"
)

func main()  {
	//rt:=html2json.NewDefault()
	appTags:=html2json.GetTags(html2json.TagUniAPP)
	rt:=html2json.New(appTags)
	htmlStr:=`
<div>
	hello world!
	<span>this is a span</span>
	a b c d e
	<img src="https://www.bookstack.cn/static/images/logo.png"/>
	<audio src="helloworld.mp3"></audio>
	<video src="../bookstack.mp4"></video>
<a href="https://www.bookstack.cn">书栈网 - 分享知识,共享智慧</a>
</div>
<iframe src="https://www.baidu.com" frameborder="0"></iframe>
<pre>
	this is pre code
</pre>
`
	now:=time.Now()
	nodes,err:=rt.Parse(htmlStr,"https://www.bookstack.cn/static/")
	if err!=nil{
		panic(err)
	}
	fmt.Println("spend time",time.Since(now))
	fmt.Println(toJSON(nodes))
}

func toJSON(v interface{}) (js string) {
	b,_:=json.Marshal(v)
	return string(b)
}

示例代码输出结果

[{
	"name": "div",
	"attrs": {
		"class": "tag-div"
	},
	"children": [{
		"type": "text",
		"text": "\n\thello world!\n\t"
	}, {
		"name": "span",
		"attrs": {
			"class": "tag-span"
		},
		"children": [{
			"type": "text",
			"text": "this is a span"
		}]
	}, {
		"type": "text",
		"text": "\n\ta b c d e\n\t"
	}, {
		"name": "img",
		"attrs": {
			"class": "tag-img",
			"src": "https://www.bookstack.cn/static/images/logo.png"
		}
	}, {
		"type": "text",
		"text": "\n\t"
	}, {
		"name": "a",
		"attrs": {
			"class": "tag-audio",
			"href": "https://www.bookstack.cn/static/helloworld.mp3",
		},
		"children": [{
			"type": "text",
			"text": " [audio] https://www.bookstack.cn/static/helloworld.mp3 "
		}]
	}, {
		"type": "text",
		"text": "\n\t"
	}, {
		"name": "a",
		"attrs": {
			"class": "tag-video",
			"href": "https://www.bookstack.cn/bookstack.mp4",
		},
		"children": [{
			"type": "text",
			"text": " [video] https://www.bookstack.cn/bookstack.mp4 "
		}]
	}, {
		"type": "text",
		"text": "\n"
	}, {
		"name": "a",
		"attrs": {
			"class": "tag-a",
			"href": "https://www.bookstack.cn"
		},
		"children": [{
			"type": "text",
			"text": "书栈网 - 分享知识,共享智慧"
		}]
	}, {
		"type": "text",
		"text": "\n"
	}]
}, {
	"type": "text",
	"text": "\n"
}, {
	"name": "a",
	"attrs": {
		"class": "tag-iframe",
		"frameborder": "0",
		"href": "https://www.baidu.com",
	},
	"children": [{
		"type": "text",
		"text": " [iframe] https://www.baidu.com "
	}]
}, {
	"type": "text",
	"text": "\n"
}, {
	"name": "div",
	"attrs": {
		"class": "tag-pre",
		"style": "display: block;font-family: monospace;white-space: pre;margin: 1em 0;"
	},
	"children": [{
		"type": "text",
		"text": "\tthis is pre code\n"
	}]
}, {
	"type": "text",
	"text": "\n"
}]

说明

所有标签都会生成一个 "tag-"+标签名class,以便于对标签进行样式控制。

比如 a标签,会添加上tag-a的class,div标签会添加一个tag-divcode标签会添加一个 tag-code的class,以此类推。

特别注释事项

由于部分小程序rich-text组件并不支持pre标签,所以pre标签会被转为div标签,并且多出一个tag-pre的class,同时会在增加一个 pre标签本身默认的css样式:

display: block;
font-family: monospace;
white-space: pre;
margin: 1em 0;

同时,如果videoiframeaudio标签,如果不在信任的标签里面,则作为a标签处理

程序体验

编译好了的程序,只有一个可执行文件,部署和使用都和简单。

如果是部署到线上生产环境,需要设置守护进程。

注意:如果服务不对外提供API请求服务,建议把端口不对外网开放

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

Go语言开发的HTML和Markdown转JSON工具,将HTML和Markdown内容转换为符合各种小程序`rich-text`组件内容渲染所需格式的`JSON` 展开 收起
Go
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Go
1
https://gitee.com/truthhun/html2json.git
git@gitee.com:truthhun/html2json.git
truthhun
html2json
html2json
master

搜索帮助