# user-agreement-gen **Repository Path**: 3fish/user-agreement-gen ## Basic Information - **Project Name**: user-agreement-gen - **Description**: No description available - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2026-05-25 - **Last Updated**: 2026-07-06 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # 法务页面模板说明 这个目录提供两类页面: - 动态模板页面:运行时根据配置文件渲染公司名称、品牌名称、服务名称等信息 - 静态生成页面:根据不同配置预先输出最终 HTML,方便直接部署或交付 当前包含四份页面: - `privacy-policy.html`:隐私政策 - `user-agreement.html`:用户协议 - `about-us.html`:关于我们 - `help-center.html`:帮助中心 ## 目录结构 ```text draft/ ├── about-us.html ├── help-center.html ├── privacy-policy.html ├── user-agreement.html ├── legal-config-loader.js ├── legal-config.default.js ├── legal-config.demo.js ├── legal-config.cangying.js ├── build-legal-html.js └── dist/ ``` ## 配置文件约定 配置文件命名格式: ```text legal-config.<配置名>.js ``` 例如: - `legal-config.default.js` - `legal-config.demo.js` - `legal-config.cangying.js` 每个配置文件都需要导出: ```js window.LEGAL_CONFIG = { companyName: "公司名称", brandName: "品牌名称", serviceName: "产品或服务名称", email: "联系邮箱", phone: "联系电话", address: "联系地址" }; ``` 字段说明: - `companyName`:公司主体名称 - `brandName`:品牌名称 - `serviceName`:产品或服务名称 - `email`:联系邮箱 - `phone`:联系电话 - `address`:联系地址 说明: - 页面展示时优先使用 `brandName` - 如果 `brandName` 还是默认占位符,则会回退为 `serviceName` ## 动态模式 动态模式下,页面在打开时读取同级目录配置文件并渲染。 默认配置: - 不带参数时,读取 `legal-config.default.js` 指定配置: - 通过 URL 参数 `config` 指定配置名 示例: ```text about-us.html?config=demo help-center.html?config=demo privacy-policy.html?config=demo user-agreement.html?config=cangying ``` 动态模式适合: - 本地预览 - 多品牌共用一套模板 - 调试配置内容 ## 静态生成模式 静态模式会把每个配置渲染成最终 HTML 文件,输出到 `dist/<配置名>/` 目录。 ### 生成全部配置 ```bash source ~/.nvm/nvm.sh && nvm use 24 >/dev/null && node build-legal-html.js ``` ### 只生成某个配置 ```bash source ~/.nvm/nvm.sh && nvm use 24 >/dev/null && node build-legal-html.js cangying ``` 也支持传完整文件名: ```bash source ~/.nvm/nvm.sh && nvm use 24 >/dev/null && node build-legal-html.js legal-config.cangying.js ``` 生成结果示例: ```text dist/ ├── cangying/ │ ├── about-us.html │ ├── help-center.html │ ├── privacy-policy.html │ └── user-agreement.html ├── default/ │ ├── about-us.html │ ├── help-center.html │ ├── privacy-policy.html │ └── user-agreement.html └── demo/ ├── about-us.html ├── help-center.html ├── privacy-policy.html └── user-agreement.html ``` 静态模式适合: - 直接部署到静态站点 - 输出给运营、法务或第三方 - 为每个品牌单独交付最终文件 ## 推荐工作流 ### 新增一个品牌 1. 复制一份配置文件,例如复制 `legal-config.demo.js` 2. 改名为 `legal-config.<你的配置名>.js` 3. 填入该品牌的公司和联系信息 4. 执行静态生成脚本 5. 在 `dist/<你的配置名>/` 下查看生成结果 ### 更新配置后重新生成 静态文件不会自动跟随配置文件更新。 如果你修改了: - `legal-config.cangying.js` 需要重新执行: ```bash source ~/.nvm/nvm.sh && nvm use 24 >/dev/null && node build-legal-html.js cangying ``` 如果你不重新执行,`dist/cangying/` 里的 HTML 会继续保留旧内容。 ## 常见问题 ### 1. 为什么我改了配置,`dist` 里的页面没变? 因为 `dist` 里的文件是静态生成结果,不会自动联动更新。 修改配置后,需要重新运行生成脚本。 ### 2. 我改的是 `legal-config.cangying.js`,为什么看到的还是旧内容? 先确认两件事: - 文件是否已经保存到磁盘 - 你打开的是不是 `dist/cangying/` 下的结果,而不是别的配置目录 ### 3. 动态模式和静态模式有什么区别? - 动态模式:打开页面时按 URL 参数读取配置 - 静态模式:提前把配置写死进 HTML,生成最终文件 ### 4. 哪些文件是模板,哪些文件是产物? 模板文件: - `privacy-policy.html` - `user-agreement.html` - `about-us.html` - `help-center.html` - `legal-config-loader.js` - `legal-config.*.js` - `build-legal-html.js` 产物文件: - `dist/<配置名>/about-us.html` - `dist/<配置名>/help-center.html` - `dist/<配置名>/privacy-policy.html` - `dist/<配置名>/user-agreement.html` ## 后续可扩展 如果后面要继续增强,可以考虑: - 增加 `watch` 模式,配置修改后自动重新生成 - 增加 `index.html`,统一展示所有品牌的生成结果 - 把配置从 `.js` 扩展到 `.json` - 增加更多法务模板页面,例如注销协议、儿童隐私政策、第三方 SDK 说明