mirror of
https://github.com/2234839/web-font.git
synced 2026-04-30 21:53:36 +08:00
99 lines
3.7 KiB
Markdown
99 lines
3.7 KiB
Markdown
# web font 字体裁剪工具
|
||
|
||
之前的版本请查看 master 分支，为了能使用 llrt ，我进行了重写，之后只维护此分支
|
||
|
||
|
||
|
||
上面的内存占用是空载状态下，在执行字体裁剪时会将字体加载到内存中，所以会占用更多的内存，不过 llrt 也具有 gc 功能，在内存不够用时会自动释放。
|
||
虽然 llrt 内存占用低，但它运行速度慢，不到node的1/2。有运行速度要求的建议使用node/bun运行
|
||
|
||
## 起因
|
||
|
||
ui 需要展现一些特定的字体，但直接引入字体包又过大，于是想到了裁剪字体，一开始想的使用「字蛛」但他是针对静态网站的，而且实际他会多出许多英文的，估计是直接将源码中存在的文字都算进去了。后来又找到阿里的「webfont」 但他的字体有限，项目又不开源，所以自己写了这个
|
||
|
||
## 在线尝试
|
||
|
||
- [web font 在线站点](https://webfont.shenzilong.cn/)
|
||
|
||
## 目的与功能
|
||
|
||
1.裁剪字体包使其仅包含选中的字体,其体积自然十分之小
|
||
2.另外可以生成 css 直接复制可用，部署在公网便可永久访问
|
||
3.支持字体文件上传（临时上传和管理员上传两种模式）
|
||
4.支持下载裁剪后的字体文件
|
||
5.字体名称支持模糊匹配（精确 > 前缀 > 包含）
|
||
|
||
|
||
## 安装与使用
|
||
|
||
### 使用 node / llrt 等运行时
|
||
|
||
拉取项目，并将字体文件放到项目内的 font 目录下，然后运行：
|
||
|
||
pnpm install && pnpm build && pnpm build_backend
|
||
|
||
node ./dist_backend/app.cjs
|
||
llrt ./dist_backend/app.cjs
|
||
|
||
|
||
### 使用 docker 安装
|
||
|
||
此镜像使用 llrt 运行时
|
||
|
||
https://hub.docker.com/repository/docker/llej0/web-font 很小的包体积 
|
||
|
||
docker compose.yml
|
||
|
||
```yml
|
||
version: '3'
|
||
services:
|
||
app:
|
||
image: docker.io/llej0/web-font:latest
|
||
ports:
|
||
- "8087:8087"
|
||
volumes:
|
||
- ./data:/home/font # 挂载本机字体目录
|
||
environment:
|
||
- ENABLE_TEMP_UPLOAD=true # 开启临时上传（默认 false）
|
||
- TEMP_MAX_FILES=10 # 临时上传最大文件数（默认 10）
|
||
- TEMP_MAX_TOTAL_SIZE=209715200 # 临时上传目录总体积上限，单位字节（默认 209715200，即 200MB）
|
||
- ADMIN_API_KEY=你的管理员密钥 # 设置后开启管理员上传，不设置则不可用
|
||
deploy:
|
||
resources:
|
||
limits:
|
||
memory: 900M # 设置内存限制为900MB，根据实际需求来设置
|
||
restart: on-failure # 设置重启策略为 on-failure
|
||
|
||
```
|
||
|
||
其中 font 目录替换成你的字体文件存放目录
|
||
|
||
## 提供的服务
|
||
|
||
### API 接口
|
||
|
||
| 接口 | 说明 |
|
||
|------|------|
|
||
| `GET /api?font=字体名&text=文字` | 裁剪字体，字体名支持模糊匹配 |
|
||
| `GET /api/fonts` | 列出所有可用字体 |
|
||
| `GET /api/config` | 获取公开配置（是否开启上传等） |
|
||
| `POST /api/upload?mode=temp` | 临时上传字体文件（需开启 `ENABLE_TEMP_UPLOAD`） |
|
||
| `POST /api/upload?mode=admin` | 管理员上传字体文件（需 `Authorization: Bearer <API_KEY>`） |
|
||
|
||
### 上传功能
|
||
|
||
- **临时上传**：设置环境变量 `ENABLE_TEMP_UPLOAD=true` 启用，最多保留 10 个字体文件（`TEMP_MAX_FILES`），总大小限制 200MB（`TEMP_MAX_TOTAL_SIZE`），超出后自动删除最早上传的（FIFO）
|
||
- **管理员上传**：设置环境变量 `ADMIN_API_KEY=你的密钥` 启用，上传的字体永久保存，需要通过 API Key 认证
|
||
- 支持的字体格式：`.ttf` `.otf` `.woff` `.woff2`
|
||
|
||
## 鸣谢
|
||
|
||
[kekee000/fonteditor-core](https://github.com/kekee000/fonteditor-core)
|
||
|
||
[字体天下](http://www.fonts.net.cn/commercial-free-32767/fonts-zh-1.html)
|
||
|
||
|
||
## License
|
||
|
||
MIT © [崮生](https://shenzilong.cn/关于/mit.html)
|