快速开始
安装
bash
npm install icon-combinder作为库引用
js
const {
renderComposite,
createNodeRuntime,
loadImageFromReference,
} = require("icon-combinder");如果你用的是打包器,也可以按同名命名导入读取这些能力。
启动本地测试服务
bash
npm start默认会监听 http://localhost:3000,可直接打开:
bash
http://localhost:3000/ui.html这个服务的主要作用是快速试参数,而不是长期对外托管。
文档站点
本仓库使用 VitePress 生成静态文档站点。
bash
npm run docs:dev本地预览构建结果:
bash
npm run docs:build
npm run docs:preview常用环境变量
PORT:服务端口ENABLE_CORS:是否开启跨域IMAGE_URL_PREFIX:相对路径图片的基础前缀IMAGE_URL_PREFIX_ONLY:是否限制图片地址必须命中前缀IMAGE_ENABLE_BASE64:是否允许data:image/*;base64,...IMG_BED_BASE_URL:GET模式文件上传使用的图床地址
发布前检查
- 确认文档站点可通过
npm run docs:build成功构建 - 确认 npm 包只包含
package.json中files白名单里的内容 - 确认 GitHub Pages 的
base与仓库路径一致