xiangjsoncraft 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +181 -0
- package/package.json +13 -13
- package/Readme.md +0 -315
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
|
|
2
|
+

|
|
3
|
+
|
|
4
|
+
# XiangJsonCraft 软件包 官方文档
|
|
5
|
+
|
|
6
|
+
XiangJsonCraft 是一个简单而强大的 JSON 配置与 HTML 页面渲染工具,是由大学生董翔开发,专为前端开发者设计。通过简洁的 API,它允许你使用 JSON 配置文件来定义样式和内容,并将其应用到 HTML 页面中,实现动态页面的快速构建。
|
|
7
|
+
|
|
8
|
+
## 特性
|
|
9
|
+
|
|
10
|
+
- **简单易用**:只需几行代码即可完成页面渲染
|
|
11
|
+
- **灵活配置**:通过 JSON 文件定义样式和内容
|
|
12
|
+
- **轻量级**:无额外依赖,体积小巧
|
|
13
|
+
|
|
14
|
+
## 安装
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install xiangjsoncraft
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## 快速开始
|
|
21
|
+
|
|
22
|
+
### 1. 创建 JSON 配置文件
|
|
23
|
+
|
|
24
|
+
首先,创建一个 JSON 配置文件 `config.json`,定义页面的样式和内容:
|
|
25
|
+
|
|
26
|
+
```json
|
|
27
|
+
{
|
|
28
|
+
"styles": {
|
|
29
|
+
"body": {
|
|
30
|
+
"margin": "0",
|
|
31
|
+
"padding": "0",
|
|
32
|
+
"boxSizing": "border-box"
|
|
33
|
+
},
|
|
34
|
+
"header": {
|
|
35
|
+
"display": "flex",
|
|
36
|
+
"justifyContent": "center",
|
|
37
|
+
"alignItems": "center",
|
|
38
|
+
"padding": "10px",
|
|
39
|
+
"backgroundColor": "azure"
|
|
40
|
+
},
|
|
41
|
+
"headerP": {
|
|
42
|
+
"color": "black",
|
|
43
|
+
"fontSize": "16px"
|
|
44
|
+
}
|
|
45
|
+
},
|
|
46
|
+
"content": {
|
|
47
|
+
"headerText": "Dynamic Header Text"
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### 2. 创建 HTML 页面
|
|
53
|
+
|
|
54
|
+
然后,创建一个 HTML 页面 `index.html`,引入 JavaScript 文件:
|
|
55
|
+
|
|
56
|
+
```html
|
|
57
|
+
<!DOCTYPE html>
|
|
58
|
+
<html lang="en">
|
|
59
|
+
<head>
|
|
60
|
+
<meta charset="UTF-8">
|
|
61
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
62
|
+
<title>Document</title>
|
|
63
|
+
<style id="style-block"></style>
|
|
64
|
+
</head>
|
|
65
|
+
<body>
|
|
66
|
+
<header>
|
|
67
|
+
<p id="header-text"></p>
|
|
68
|
+
</header>
|
|
69
|
+
<!-- 引入外部 JavaScript 文件 -->
|
|
70
|
+
<script type="module">
|
|
71
|
+
import { renderJson } from './renderJson.js';
|
|
72
|
+
renderJson();
|
|
73
|
+
</script>
|
|
74
|
+
</body>
|
|
75
|
+
</html>
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### 3. 编写渲染函数
|
|
79
|
+
|
|
80
|
+
在 `renderJson.js` 中编写渲染函数:
|
|
81
|
+
|
|
82
|
+
```javascript
|
|
83
|
+
// 定义 replaceCamelCase 方法
|
|
84
|
+
String.prototype.replaceCamelCase = function (separator = '-') {
|
|
85
|
+
return this.replace(/[A-Z]/g, function (match) {
|
|
86
|
+
return separator + match.toLowerCase();
|
|
87
|
+
});
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
// 封装 JSON 渲染函数
|
|
91
|
+
function renderJson() {
|
|
92
|
+
// 使用 fetch API 获取 JSON 文件
|
|
93
|
+
fetch('./config.json')
|
|
94
|
+
.then(response => {
|
|
95
|
+
// 检查响应是否成功
|
|
96
|
+
if (!response.ok) {
|
|
97
|
+
throw new Error('网络响应失败');
|
|
98
|
+
}
|
|
99
|
+
// 将响应转换为 JSON 格式
|
|
100
|
+
return response.json();
|
|
101
|
+
})
|
|
102
|
+
.then(config => {
|
|
103
|
+
// 动态创建样式表
|
|
104
|
+
const styleBlock = document.getElementById('style-block');
|
|
105
|
+
styleBlock.innerHTML = `
|
|
106
|
+
* { ${Object.entries(config.styles.body).map(([key, value]) => `${key}: ${value};`).join(' ')} }
|
|
107
|
+
header { ${Object.entries(config.styles.header).map(([key, value]) => `${key.replaceCamelCase()}: ${value};`).join(' ')} }
|
|
108
|
+
header p { ${Object.entries(config.styles.headerP).map(([key, value]) => `${key}: ${value};`).join(' ')} }
|
|
109
|
+
`;
|
|
110
|
+
|
|
111
|
+
// 动态设置内容
|
|
112
|
+
document.getElementById('header-text').innerText = config.content.headerText;
|
|
113
|
+
})
|
|
114
|
+
.catch(error => {
|
|
115
|
+
console.error('获取 JSON 文件时出错:', error);
|
|
116
|
+
});
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
// 导出渲染函数
|
|
120
|
+
export { renderJson };
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### 4. 运行项目
|
|
124
|
+
|
|
125
|
+
在浏览器中打开 `index.html` 文件,即可看到渲染后的页面。
|
|
126
|
+
|
|
127
|
+
## API 文档
|
|
128
|
+
|
|
129
|
+
### `renderJson()`
|
|
130
|
+
|
|
131
|
+
从 `config.json` 文件中读取样式和内容配置,并将其应用到 HTML 页面中。
|
|
132
|
+
|
|
133
|
+
#### 示例
|
|
134
|
+
|
|
135
|
+
```javascript
|
|
136
|
+
import { renderJson } from './renderJson.js';
|
|
137
|
+
renderJson();
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
## 贡献指南
|
|
141
|
+
|
|
142
|
+
我们欢迎任何人贡献代码或提出建议。如果你想参与开发,请遵循以下步骤:
|
|
143
|
+
|
|
144
|
+
1. 克隆仓库:`git clone https://github.com/dxiang-wiki/xiangjsoncraft.git`
|
|
145
|
+
2. 创建新分支:`git checkout -b feature/your-feature`
|
|
146
|
+
3. 提交代码:`git commit -m "Add your feature"`
|
|
147
|
+
4. 推送分支:`git push origin feature/your-feature`
|
|
148
|
+
5. 创建 Pull Request
|
|
149
|
+
|
|
150
|
+
## 许可证
|
|
151
|
+
|
|
152
|
+
MIT License
|
|
153
|
+
|
|
154
|
+
Copyright (c) 2025 xiang
|
|
155
|
+
|
|
156
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
157
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
158
|
+
in the Software without restriction, including without limitation the rights
|
|
159
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
160
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
161
|
+
furnished to do so, subject to the following conditions:
|
|
162
|
+
|
|
163
|
+
The above copyright notice and this permission notice shall be included in all
|
|
164
|
+
copies or substantial portions of the Software.
|
|
165
|
+
|
|
166
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
167
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
168
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
169
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
170
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
171
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
172
|
+
SOFTWARE.
|
|
173
|
+
|
|
174
|
+
## 联系我们
|
|
175
|
+
|
|
176
|
+
如果你有任何问题或建议,请通过以下方式联系我们:
|
|
177
|
+
|
|
178
|
+
- GitHub Issues: https://github.com/dxiang-wiki/xiangjsoncraft/issues
|
|
179
|
+
- Email: 3631247406@qq.com
|
|
180
|
+
|
|
181
|
+
感谢使用 XiangJsonCraft!
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "xiangjsoncraft",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "",
|
|
5
|
-
"main": "renderJson.js",
|
|
6
|
-
"scripts": {
|
|
7
|
-
"test": "echo \"Error: no test specified\" && exit 1"
|
|
8
|
-
},
|
|
9
|
-
"keywords": [],
|
|
10
|
-
"author": "",
|
|
11
|
-
"license": "ISC",
|
|
12
|
-
"type": "commonjs"
|
|
13
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "xiangjsoncraft",
|
|
3
|
+
"version": "1.0.3",
|
|
4
|
+
"description": "",
|
|
5
|
+
"main": "renderJson.js",
|
|
6
|
+
"scripts": {
|
|
7
|
+
"test": "echo \"Error: no test specified\" && exit 1"
|
|
8
|
+
},
|
|
9
|
+
"keywords": [],
|
|
10
|
+
"author": "",
|
|
11
|
+
"license": "ISC",
|
|
12
|
+
"type": "commonjs"
|
|
13
|
+
}
|
package/Readme.md
DELETED
|
@@ -1,315 +0,0 @@
|
|
|
1
|
-
### XiangJsonCraft - 轻量级JSON配置与模板渲染工具
|
|
2
|
-
|
|
3
|
-

|
|
4
|
-
|
|
5
|
-
# XiangJsonCraft
|
|
6
|
-
|
|
7
|
-
XiangJsonCraft是一个简单而强大的JSON配置与HTML模板渲染工具,专为前端开发者设计。通过简洁的API,它允许你使用JSON配置文件来定义样式和内容,并将其应用到HTML模板中,实现动态页面的快速构建。
|
|
8
|
-
|
|
9
|
-
## 特性
|
|
10
|
-
|
|
11
|
-
- **简单易用**:只需几行代码即可完成模板渲染
|
|
12
|
-
- **灵活配置**:通过JSON文件定义样式和内容
|
|
13
|
-
- **轻量级**:无额外依赖,体积小巧
|
|
14
|
-
- **高效渲染**:支持批量处理和动态更新
|
|
15
|
-
- **类型安全**:提供完整的TypeScript类型定义
|
|
16
|
-
|
|
17
|
-
## 安装
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
npm install xiangjsoncraft
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## 快速开始
|
|
24
|
-
|
|
25
|
-
### 1. 创建JSON配置文件
|
|
26
|
-
|
|
27
|
-
首先,创建一个JSON配置文件,定义页面的样式和内容:
|
|
28
|
-
|
|
29
|
-
```json
|
|
30
|
-
// config.json
|
|
31
|
-
{
|
|
32
|
-
"styles": {
|
|
33
|
-
"body": {
|
|
34
|
-
"margin": "0",
|
|
35
|
-
"padding": "0",
|
|
36
|
-
"fontFamily": "Arial, sans-serif"
|
|
37
|
-
},
|
|
38
|
-
"header": {
|
|
39
|
-
"backgroundColor": "#3498db",
|
|
40
|
-
"color": "white",
|
|
41
|
-
"padding": "20px",
|
|
42
|
-
"textAlign": "center"
|
|
43
|
-
},
|
|
44
|
-
"content": {
|
|
45
|
-
"maxWidth": "800px",
|
|
46
|
-
"margin": "0 auto",
|
|
47
|
-
"padding": "20px"
|
|
48
|
-
}
|
|
49
|
-
},
|
|
50
|
-
"content": {
|
|
51
|
-
"title": "欢迎使用XiangJsonCraft",
|
|
52
|
-
"subtitle": "简单高效的JSON配置与模板渲染工具",
|
|
53
|
-
"paragraph": "XiangJsonCraft让你可以通过JSON配置文件轻松定义页面样式和内容,无需编写复杂的CSS和JavaScript代码。"
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
### 2. 创建HTML模板
|
|
59
|
-
|
|
60
|
-
然后,创建一个HTML模板文件,使用占位符来表示动态内容:
|
|
61
|
-
|
|
62
|
-
```html
|
|
63
|
-
<!-- template.html -->
|
|
64
|
-
<!DOCTYPE html>
|
|
65
|
-
<html lang="zh-CN">
|
|
66
|
-
<head>
|
|
67
|
-
<meta charset="UTF-8">
|
|
68
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
69
|
-
<title>{{title}}</title>
|
|
70
|
-
<style id="dynamic-styles"></style>
|
|
71
|
-
</head>
|
|
72
|
-
<body>
|
|
73
|
-
<header class="header">
|
|
74
|
-
<h1>{{title}}</h1>
|
|
75
|
-
<p>{{subtitle}}</p>
|
|
76
|
-
</header>
|
|
77
|
-
<div class="content">
|
|
78
|
-
<p>{{paragraph}}</p>
|
|
79
|
-
</div>
|
|
80
|
-
</body>
|
|
81
|
-
</html>
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
### 3. 使用XiangJsonCraft渲染模板
|
|
85
|
-
|
|
86
|
-
最后,在JavaScript代码中使用XiangJsonCraft来渲染模板:
|
|
87
|
-
|
|
88
|
-
```javascript
|
|
89
|
-
const { renderTemplate } = require('xiangjsoncraft');
|
|
90
|
-
const fs = require('fs');
|
|
91
|
-
const path = require('path');
|
|
92
|
-
|
|
93
|
-
// 读取配置文件和模板文件
|
|
94
|
-
const config = JSON.parse(fs.readFileSync(path.join(__dirname, 'config.json'), 'utf8'));
|
|
95
|
-
const template = fs.readFileSync(path.join(__dirname, 'template.html'), 'utf8');
|
|
96
|
-
|
|
97
|
-
// 渲染模板
|
|
98
|
-
const renderedHtml = renderTemplate(template, config);
|
|
99
|
-
|
|
100
|
-
// 输出渲染结果
|
|
101
|
-
console.log(renderedHtml);
|
|
102
|
-
|
|
103
|
-
// 保存渲染结果到文件
|
|
104
|
-
fs.writeFileSync(path.join(__dirname, 'output.html'), renderedHtml);
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
## API文档
|
|
108
|
-
|
|
109
|
-
### `renderTemplate(template: string, config: Config): string`
|
|
110
|
-
|
|
111
|
-
将HTML模板和JSON配置文件渲染为最终的HTML字符串。
|
|
112
|
-
|
|
113
|
-
#### 参数
|
|
114
|
-
|
|
115
|
-
- `template`: 字符串,HTML模板内容
|
|
116
|
-
- `config`: 对象,包含样式和内容配置
|
|
117
|
-
|
|
118
|
-
#### 返回值
|
|
119
|
-
|
|
120
|
-
- 字符串,渲染后的HTML内容
|
|
121
|
-
|
|
122
|
-
#### 示例
|
|
123
|
-
|
|
124
|
-
```javascript
|
|
125
|
-
const renderedHtml = renderTemplate('<div class="container">{{title}}</div>', {
|
|
126
|
-
styles: {
|
|
127
|
-
container: {
|
|
128
|
-
backgroundColor: 'lightblue',
|
|
129
|
-
padding: '10px'
|
|
130
|
-
}
|
|
131
|
-
},
|
|
132
|
-
content: {
|
|
133
|
-
title: 'Hello, XiangJsonCraft!'
|
|
134
|
-
}
|
|
135
|
-
});
|
|
136
|
-
|
|
137
|
-
console.log(renderedHtml);
|
|
138
|
-
// 输出: <div class="container" style="background-color: lightblue; padding: 10px;">Hello, XiangJsonCraft!</div>
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
### 配置文件格式
|
|
142
|
-
|
|
143
|
-
配置文件是一个JSON对象,包含两个主要属性:
|
|
144
|
-
|
|
145
|
-
#### `styles`
|
|
146
|
-
|
|
147
|
-
定义CSS样式的对象,每个键对应一个HTML元素的类名或ID,值是CSS属性的键值对。
|
|
148
|
-
|
|
149
|
-
```json
|
|
150
|
-
{
|
|
151
|
-
"styles": {
|
|
152
|
-
"myClass": {
|
|
153
|
-
"color": "red",
|
|
154
|
-
"fontSize": "16px"
|
|
155
|
-
},
|
|
156
|
-
"#myId": {
|
|
157
|
-
"backgroundColor": "blue",
|
|
158
|
-
"width": "100px"
|
|
159
|
-
}
|
|
160
|
-
}
|
|
161
|
-
}
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
#### `content`
|
|
165
|
-
|
|
166
|
-
定义动态内容的对象,键对应HTML模板中的占位符(如`{{title}}`),值是要替换的内容。
|
|
167
|
-
|
|
168
|
-
```json
|
|
169
|
-
{
|
|
170
|
-
"content": {
|
|
171
|
-
"title": "页面标题",
|
|
172
|
-
"description": "这是一个描述文本"
|
|
173
|
-
}
|
|
174
|
-
}
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
## 高级用法
|
|
178
|
-
|
|
179
|
-
### 批量处理多个模板
|
|
180
|
-
|
|
181
|
-
你可以使用XiangJsonCraft批量处理多个模板文件:
|
|
182
|
-
|
|
183
|
-
```javascript
|
|
184
|
-
const { renderTemplate } = require('xiangjsoncraft');
|
|
185
|
-
const fs = require('fs');
|
|
186
|
-
const path = require('path');
|
|
187
|
-
|
|
188
|
-
// 读取配置文件
|
|
189
|
-
const config = JSON.parse(fs.readFileSync(path.join(__dirname, 'config.json'), 'utf8'));
|
|
190
|
-
|
|
191
|
-
// 读取模板目录中的所有文件
|
|
192
|
-
const templatesDir = path.join(__dirname, 'templates');
|
|
193
|
-
const outputDir = path.join(__dirname, 'output');
|
|
194
|
-
|
|
195
|
-
// 确保输出目录存在
|
|
196
|
-
if (!fs.existsSync(outputDir)) {
|
|
197
|
-
fs.mkdirSync(outputDir);
|
|
198
|
-
}
|
|
199
|
-
|
|
200
|
-
// 读取所有模板文件并渲染
|
|
201
|
-
fs.readdirSync(templatesDir).forEach(file => {
|
|
202
|
-
if (file.endsWith('.html')) {
|
|
203
|
-
const templatePath = path.join(templatesDir, file);
|
|
204
|
-
const template = fs.readFileSync(templatePath, 'utf8');
|
|
205
|
-
|
|
206
|
-
// 渲染模板
|
|
207
|
-
const renderedHtml = renderTemplate(template, config);
|
|
208
|
-
|
|
209
|
-
// 保存渲染结果
|
|
210
|
-
const outputPath = path.join(outputDir, file);
|
|
211
|
-
fs.writeFileSync(outputPath, renderedHtml);
|
|
212
|
-
|
|
213
|
-
console.log(`已渲染并保存: ${file}`);
|
|
214
|
-
}
|
|
215
|
-
});
|
|
216
|
-
```
|
|
217
|
-
|
|
218
|
-
### 在浏览器中使用
|
|
219
|
-
|
|
220
|
-
XiangJsonCraft也可以在浏览器环境中使用:
|
|
221
|
-
|
|
222
|
-
```html
|
|
223
|
-
<!DOCTYPE html>
|
|
224
|
-
<html lang="zh-CN">
|
|
225
|
-
<head>
|
|
226
|
-
<meta charset="UTF-8">
|
|
227
|
-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
228
|
-
<title>浏览器中使用XiangJsonCraft</title>
|
|
229
|
-
<script src="https://cdn.jsdelivr.net/npm/xiangjsoncraft/dist/xiangjsoncraft.min.js"></script>
|
|
230
|
-
</head>
|
|
231
|
-
<body>
|
|
232
|
-
<div id="app"></div>
|
|
233
|
-
|
|
234
|
-
<script>
|
|
235
|
-
// 定义配置
|
|
236
|
-
const config = {
|
|
237
|
-
styles: {
|
|
238
|
-
app: {
|
|
239
|
-
maxWidth: '600px',
|
|
240
|
-
margin: '0 auto',
|
|
241
|
-
padding: '20px',
|
|
242
|
-
border: '1px solid #ddd',
|
|
243
|
-
borderRadius: '5px'
|
|
244
|
-
},
|
|
245
|
-
title: {
|
|
246
|
-
color: '#3498db',
|
|
247
|
-
textAlign: 'center'
|
|
248
|
-
}
|
|
249
|
-
},
|
|
250
|
-
content: {
|
|
251
|
-
title: '欢迎使用XiangJsonCraft',
|
|
252
|
-
message: '这是在浏览器中使用XiangJsonCraft的示例。'
|
|
253
|
-
}
|
|
254
|
-
};
|
|
255
|
-
|
|
256
|
-
// 定义模板
|
|
257
|
-
const template = `
|
|
258
|
-
<div class="app">
|
|
259
|
-
<h1 class="title">{{title}}</h1>
|
|
260
|
-
<p>{{message}}</p>
|
|
261
|
-
</div>
|
|
262
|
-
`;
|
|
263
|
-
|
|
264
|
-
// 渲染模板
|
|
265
|
-
const renderedHtml = XiangJsonCraft.renderTemplate(template, config);
|
|
266
|
-
|
|
267
|
-
// 将渲染结果插入到DOM中
|
|
268
|
-
document.getElementById('app').innerHTML = renderedHtml;
|
|
269
|
-
</script>
|
|
270
|
-
</body>
|
|
271
|
-
</html>
|
|
272
|
-
```
|
|
273
|
-
|
|
274
|
-
## 贡献指南
|
|
275
|
-
|
|
276
|
-
我们欢迎任何人贡献代码或提出建议。如果你想参与开发,请遵循以下步骤:
|
|
277
|
-
|
|
278
|
-
1. 克隆仓库:`git clone https://github.com/yourusername/xiangjsoncraft.git`
|
|
279
|
-
2. 创建新分支:`git checkout -b feature/your-feature`
|
|
280
|
-
3. 提交代码:`git commit -m "Add your feature"`
|
|
281
|
-
4. 推送分支:`git push origin feature/your-feature`
|
|
282
|
-
5. 创建Pull Request
|
|
283
|
-
|
|
284
|
-
## 许可证
|
|
285
|
-
|
|
286
|
-
MIT License
|
|
287
|
-
|
|
288
|
-
Copyright (c) 2023 xiang
|
|
289
|
-
|
|
290
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
291
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
292
|
-
in the Software without restriction, including without limitation the rights
|
|
293
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
294
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
295
|
-
furnished to do so, subject to the following conditions:
|
|
296
|
-
|
|
297
|
-
The above copyright notice and this permission notice shall be included in all
|
|
298
|
-
copies or substantial portions of the Software.
|
|
299
|
-
|
|
300
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
301
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
302
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
303
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
304
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
305
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
306
|
-
SOFTWARE.
|
|
307
|
-
|
|
308
|
-
## 联系我们
|
|
309
|
-
|
|
310
|
-
如果你有任何问题或建议,请通过以下方式联系我们:
|
|
311
|
-
|
|
312
|
-
- GitHub Issues: https://github.com/yourusername/xiangjsoncraft/issues
|
|
313
|
-
- Email: xiang@example.com
|
|
314
|
-
|
|
315
|
-
感谢使用XiangJsonCraft!
|