Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
github: wybaby168
custom:
- https://dev.flyfish.group/sponsor?source=github
- https://dev.flyfish.group/shop
50 changes: 33 additions & 17 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,48 @@
# 支持方式
# 支持与反馈

File Viewer 是一个开源项目,适合通过 GitHub issue 讨论公开问题、复现样例和改进建议
File Viewer 是一个公开维护的开源项目。通用使用问题、可公开复现的 Bug、兼容性反馈和改进建议,应优先通过文档、Demo 和 GitHub issue 处理;涉及敏感文件、确定交付范围或固定响应时间的需求,应使用企业技术支持

## 推荐求助路径

- 使用问题: 先看 [文档](https://doc.file-viewer.app) 和 [FAQ](https://doc.file-viewer.app/guide/faq)
- 在线验证: 使用 [Demo](https://demo.file-viewer.app) 上传脱敏文件或打开示例文件
- Bug / 兼容性问题: 提交 GitHub issue,并尽量附上复现信息
- 新格式 / 新框架支持: 提交 feature request,说明业务场景和优先级
- 私有化部署: 说明部署方式、静态资源路径、CSP、浏览器环境和失败资源
- 使用问题:先查看 [文档](https://doc.file-viewer.app) 和 [FAQ](https://doc.file-viewer.app/guide/faq)
- 在线验证:使用 [Demo](https://demo.file-viewer.app) 打开示例文件或上传脱敏文件
- Bug / 兼容性问题:提交 GitHub issue,并尽量附上完整复现信息
- 新格式 / 新框架支持:提交 feature request,说明业务场景、文件来源和实际优先级
- 私有化部署问题:说明部署方式、静态资源路径、CSP、浏览器环境和失败资源
- 敏感文件、定制兼容或明确期限:[企业技术支持](https://dev.flyfish.group/shop)

## issue 前请准备
## 提交 issue 前请准备

- 文件类型和文件来源
- 文件类型、文件来源和生成软件
- 浏览器、操作系统、移动端 WebView 信息
- 使用的包名和版本
- 接入方式: Vue / React / Web Component / script 标签 / jQuery / Svelte
- 使用的包名和准确版本
- 接入方式Vue / React / Web Component / script 标签 / jQuery / Svelte
- 是否使用 `@file-viewer/*-full`、preset 或独立 renderer
- 控制台错误、网络失败资源、截图或最小复现
- 能够公开上传的脱敏样本;无法公开时请描述文件结构和失败现象

## 样本文件安全

不要上传含有隐私、商业合同、客户资料、身份证件、内部系统截图或其他敏感信息的文件。可以上传脱敏样本,或只描述文件来源、生成工具、结构特征和失败现象
不要在公开 issue 中上传含有隐私、商业合同、客户资料、身份证件、内部系统截图、源代码或其他敏感信息的文件。优先制作脱敏样本;确实需要分析原始敏感文件时,应通过单独约定范围、保密和交付边界的企业支持处理

## 赞助与企业支持
## 社区赞助

- 支持开源维护: [GitHub Sponsors](https://github.com/sponsors/wybaby168)
- 国内一次性赞赏: [微信 / 支付宝](https://dev.flyfish.group/sponsor?source=github)
- 私有化、定制兼容或明确响应时间: [企业技术支持](https://dev.flyfish.group/shop)
如果 File Viewer 为个人或团队节省了研发、部署或服务器转码成本,可以通过赞助支持公共版本持续维护:

赞助不影响开源功能和 issue 的公开处理规则。除非对应赞助档位有明确说明,否则赞助不包含 SLA 或固定响应时间。
- [完整中文赞助说明](https://doc.file-viewer.app/zh/donate)
- [GitHub Sponsors](https://github.com/sponsors/wybaby168?metadata_campaign=file-viewer-support)
- [微信 / 支付宝一次性赞赏](https://dev.flyfish.group/sponsor?source=file-viewer-support)

赞助用于真实文件兼容、回归测试、Worker/WASM 与离线资产、文档示例和版本维护。赞助不是隐藏的付费 issue 队列,不保证指定功能或 Bug 在特定日期完成;除非公开档位明确说明,否则不包含 SLA、私下咨询或敏感文件分析。

## 企业技术支持

以下需求更适合通过 [企业技术支持](https://dev.flyfish.group/shop) 单独确认:

- 私有化、纯内网或特殊 CSP 环境部署
- 指定业务文件的兼容性修复
- 需要合同、发票、保密约定或验收标准
- 需要确定交付范围、排期或响应时间
- 与现有系统、WebView、权限或文件服务的定制集成

企业服务与社区赞助相互独立。无论是否赞助,公开功能、文档、许可和正常 issue 处理规则都不会改变。
23 changes: 16 additions & 7 deletions docs/donate.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
# Support File Viewer
# Support File Viewer · 支持 File Viewer

File Viewer remains Apache-2.0 open source. Sponsorship helps fund compatibility work, documentation, examples, offline assets, and long-term maintenance.
File Viewer is an Apache-2.0 browser-native file preview project. Sponsorship helps sustain real-file compatibility, browser and framework regression, offline Worker/WASM assets, documentation, examples, releases, and long-term maintenance.

- [GitHub Sponsors](https://github.com/sponsors/wybaby168): one-time or recurring sponsorship through GitHub.
- [WeChat / Alipay](https://dev.flyfish.group/sponsor?source=github): convenient one-time support for domestic users.
- [Enterprise support](https://dev.flyfish.group/shop): private deployment, custom compatibility work, and requirements with committed response expectations.
File Viewer 是一个采用 Apache-2.0 许可的浏览器原生文件预览项目。赞助将用于真实文件兼容、浏览器与框架回归、离线 Worker/WASM 资产、文档示例、版本发布和长期维护。

GitHub Sponsors is received by [@wybaby168](https://github.com/wybaby168), the primary maintainer of File Viewer. Sponsorship supports open-source maintenance and does not include a service-level agreement unless a published tier explicitly says otherwise.
## Read the full sponsor guide · 阅读完整说明

[Read this page in English](/en/donate) · [查看中文说明](/zh/donate)
- [English sponsor guide](/en/donate)
- [中文赞助说明](/zh/donate)

## Support now · 立即支持

- [GitHub Sponsors](https://github.com/sponsors/wybaby168?metadata_campaign=file-viewer-docs-root) — one-time or recurring support / 一次性或持续赞助
- [WeChat / Alipay](https://dev.flyfish.group/sponsor?source=file-viewer-docs) — domestic one-time support / 国内一次性赞赏
- [Enterprise support](https://dev.flyfish.group/shop) — contracts, private deployment, custom compatibility, and committed delivery / 合同、私有化部署、定制兼容和明确交付

> Community sponsorship supports public maintenance and does not include an SLA or guaranteed feature delivery unless a published tier explicitly states otherwise. Organizations that require a contract, invoice, confidential file handling, or committed response time should use enterprise support.
>
> 社区赞助用于支持公开维护。除非赞助档位明确说明,否则不包含 SLA,也不保证指定功能按期交付。需要合同、发票、敏感文件处理或明确响应时间的组织,请选择企业技术支持。
57 changes: 49 additions & 8 deletions docs/en/donate.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,58 @@
# Sponsor File Viewer

File Viewer remains Apache-2.0 open source. Sponsorship helps fund rendering compatibility, documentation, examples, offline assets, and long-term maintenance.
File Viewer keeps private Office, PDF/OFD, CAD, archive, email, 3D, media, and data files in the browser instead of requiring another upload or conversion service. The public project remains Apache-2.0 open source.

## GitHub Sponsors
> If File Viewer has saved your team implementation time, server cost, or repeated compatibility work, sponsorship is a direct way to return a small part of that value to ongoing maintenance.

[Sponsor File Viewer through GitHub](https://github.com/sponsors/wybaby168) with a one-time or recurring contribution. The account belongs to [@wybaby168](https://github.com/wybaby168), the primary maintainer of File Viewer.
- [Sponsor through GitHub](https://github.com/sponsors/wybaby168?metadata_campaign=file-viewer-docs-en) — one-time or recurring support.
- [WeChat / Alipay](https://dev.flyfish.group/sponsor?source=file-viewer-docs) — convenient one-time support for domestic users.
- [Enterprise support](https://dev.flyfish.group/shop) — private deployment, scoped compatibility work, contracts, and committed response expectations.

## WeChat and Alipay
## Why sponsorship matters

Domestic supporters can use the [WeChat / Alipay support page](https://dev.flyfish.group/sponsor?source=github) for a convenient one-time contribution.
A successful demo is only the beginning. Long-term maintenance is dominated by the cases that are difficult to reproduce: Office files produced by different applications, CAD vendor extensions, damaged or encrypted archives, browser regressions, Worker and WASM loading paths, embedded fonts, old framework builds, and offline deployment constraints.

## Enterprise support
Sponsorship helps preserve focused maintenance time for the public project instead of forcing every difficult compatibility problem to wait for spare time.

Sponsorship sustains open-source maintenance and does not include a service-level agreement unless a published sponsorship tier explicitly says otherwise. For private deployment, custom compatibility work, commercial evaluation, or committed response expectations, use the [enterprise support channel](https://dev.flyfish.group/shop).
## What sponsorship funds

Whether or not you sponsor, the open-source features and documentation remain available under the same license.
| Area | What the work includes |
| --- | --- |
| Real-file compatibility | Reproducing sanitized business files, tracing parser and layout differences, and adding regression coverage. |
| Browser and framework regression | Keeping modern and legacy integrations working across browsers, WebViews, Vue, React, Svelte, jQuery, and Web Components. |
| Offline distribution | Maintaining version-aligned Workers, WASM, fonts, vendor assets, copy tools, CSP guidance, and private-network delivery. |
| Documentation and examples | Turning recurring integration problems into tested examples, migration notes, and deployment guides. |
| Sustainable maintenance time | Reviewing issues, preparing releases, updating dependencies, and handling work that is important but not visible in a feature list. |

## Choose the right support path

| Path | Best for | What it means |
| --- | --- | --- |
| GitHub Sponsors | Individuals and teams that rely on the public project | One-time or recurring support for open-source maintenance. It does not include an SLA unless a published tier explicitly says so. |
| WeChat / Alipay | Domestic users who prefer a simple one-time contribution | A direct thank-you that supports the same public maintenance work. |
| Enterprise support | Organizations that need contracts, invoices, private deployment, custom compatibility, or committed delivery | A separately scoped commercial engagement with explicit requirements, boundaries, and response expectations. |

## What should I contribute?

There is no required amount or fixed tier. A one-time “thanks, this saved me a headache” tip is useful; recurring support helps even more because maintenance time becomes easier to plan.

Choose whatever feels reasonable for the time and trouble File Viewer saved you. If your company needs an SLA, contract, invoice, confidential file handling, or a defined deliverable, use enterprise support instead. A larger donation still does not buy issue priority.

## Clear boundaries

Sponsorship supports the project; it is not a hidden paid issue queue.

- It does not guarantee that a requested format, feature, or bug fix will be accepted or completed by a specific date.
- It does not include private consulting, confidential file analysis, or a service-level agreement unless explicitly included in a published tier or enterprise agreement.
- It does not change the Apache-2.0 license or restrict access to public features and documentation.
- Sensitive files should never be attached to a public issue. Use sanitized samples or an appropriately scoped private engagement.

## Other valuable ways to help

Financial support is not the only useful contribution. Sanitized failing samples, minimal reproductions, accurate bug reports, documentation improvements, translations, case studies, and sharing the project with teams that need private file preview all materially improve File Viewer.

## Maintainer and transparency

GitHub sponsorships are received by [@wybaby168](https://github.com/wybaby168), the primary maintainer of File Viewer. The resulting open-source work remains visible through public commits, issues, documentation, release notes, and published packages.

Thank you for helping browser-native, private file preview remain practical and maintainable.
57 changes: 49 additions & 8 deletions docs/zh/donate.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,58 @@
# 赞助 File Viewer

File Viewer 会持续保持 Apache-2.0 开源。赞助主要用于真实文件兼容、文档与示例、离线资产以及项目的长期维护
File Viewer 让 Office、PDF/OFD、CAD、压缩包、邮件、3D、音视频和数据文件尽可能留在浏览器内完成预览,避免再次上传文件或额外建设转码服务。公开项目会继续保持 Apache-2.0 开源。

## GitHub Sponsors
> 如果 File Viewer 为你的团队节省了研发时间、服务器成本或长期兼容维护工作,赞助就是把其中一小部分价值直接投入项目持续维护的方式。

可通过 [GitHub Sponsors 赞助 File Viewer](https://github.com/sponsors/wybaby168),支持一次性或持续赞助。该账号属于 File Viewer 主要维护者 [@wybaby168](https://github.com/wybaby168)。
- [通过 GitHub Sponsors 赞助](https://github.com/sponsors/wybaby168?metadata_campaign=file-viewer-docs-zh) — 支持一次性或持续赞助。
- [微信 / 支付宝赞赏](https://dev.flyfish.group/sponsor?source=file-viewer-docs) — 适合国内用户的一次性支持。
- [企业技术支持](https://dev.flyfish.group/shop) — 适用于私有化部署、定制兼容、合同发票和明确响应要求。

## 微信与支付宝
## 为什么项目需要赞助

国内用户可使用 [微信 / 支付宝赞赏页](https://dev.flyfish.group/sponsor?source=github),方便完成一次性支持
能打开演示文件只是起点。长期维护真正消耗时间的,是那些很难复现和验证的真实业务问题:不同软件生成的 Office 文件、CAD 厂商扩展、损坏或加密压缩包、浏览器回归、Worker 与 WASM 资源路径、嵌入字体、旧框架构建,以及完全离线的部署环境

## 企业技术支持
赞助的意义,不是把开源功能变成付费功能,而是让这些重要却不显眼的兼容工作能够获得稳定、持续的维护时间,而不是只能等待维护者的零散业余时间。

赞助用于支持开源维护,除非对应赞助档位有明确说明,否则不包含 SLA 或固定响应时间。私有化部署、定制兼容、商业选型或需要明确交付边界的需求,请使用 [企业技术支持入口](https://dev.flyfish.group/shop)。
## 赞助会投入哪里

无论是否赞助,开源功能、文档和许可都不会受影响。
| 方向 | 具体工作 |
| --- | --- |
| 真实文件兼容 | 复现脱敏业务文件,定位解析和排版差异,并补充长期回归样例。 |
| 浏览器与框架回归 | 维护浏览器、WebView、Vue、React、Svelte、jQuery 和 Web Component 等新旧接入链路。 |
| 离线与私有化分发 | 持续维护版本一致的 Worker、WASM、字体、vendor 资产、复制工具、CSP 指南和内网部署方式。 |
| 文档与示例 | 将反复出现的接入问题沉淀为可运行示例、迁移说明和部署文档。 |
| 可持续维护时间 | 处理 issue、审核修复、发布版本、升级依赖,以及功能列表中看不到但必须完成的基础工作。 |

## 请选择合适的支持方式

| 方式 | 适合谁 | 说明 |
| --- | --- | --- |
| GitHub Sponsors | 依赖公开项目的个人开发者和团队 | 一次性或持续支持开源维护。除非赞助档位明确说明,否则不包含 SLA。 |
| 微信 / 支付宝 | 希望方便完成一次性赞赏的国内用户 | 作为对公开维护工作的直接感谢,不附带交付承诺。 |
| 企业技术支持 | 需要合同、发票、私有化部署、定制兼容或明确交付期限的组织 | 单独确认需求、范围、验收边界和响应要求,按商业服务处理。 |

## 赞助多少比较合适

没有最低金额,也没有固定档位。一次“这次真帮我省事了”的小额赞赏就有价值;持续赞助更有帮助,因为维护时间更容易安排。

按 File Viewer 实际为你节省的时间和麻烦决定即可。如果企业还需要 SLA、合同、发票、敏感文件处理或确定交付,请选择企业技术支持。赞助金额再高,也不会购买公开 issue 的优先级。

## 明确边界

赞助用于支持项目,不是隐藏的付费 issue 排队机制。

- 赞助不保证某个格式、功能或 Bug 一定被接受,也不承诺在指定日期完成。
- 除非公开赞助档位或企业协议中明确包含,否则不提供私下咨询、敏感文件分析或 SLA。
- 赞助不会改变 Apache-2.0 许可,也不会限制任何人使用公开功能和文档。
- 请勿在公开 issue 中上传隐私文件、合同、客户资料或内部文档。应优先提供脱敏样本,或通过明确范围的企业服务进行私下处理。

## 不赞助也可以提供很大帮助

脱敏失败样本、最小复现、准确的问题描述、文档修正、翻译、真实案例,以及把项目分享给真正需要私有文件预览的团队,都会直接提高 File Viewer 的质量。

## 维护者与透明度

GitHub 赞助由 File Viewer 主要维护者 [@wybaby168](https://github.com/wybaby168) 接收。由赞助支持的公开工作会继续通过提交记录、issue、文档、Release Notes 和已发布软件包体现。

感谢你帮助浏览器原生、保护隐私的文件预览方案长期保持可用和可维护。