发布与成品分发

Release For Users

这一页说明 Flyfish Viewer 对外分发时包含什么、如何安装、如何下载成品，以及源码如何自助开通。 公开 GitHub 仓库只交付混淆压缩后的构建产物、示例文件、静态文档产物和下载包。

分发渠道

渠道	地址	内容
官方文档/组件主页	doc.flyfish.dev	组件主页、接入文档、格式说明和成品分发说明
在线 Demo	viewer.flyfish.dev	可直接体验完整预览器
npm 包(Vue3)	@flyfish-group/file-viewer3	Vue3 组件库，当前 latest 为 1.0.8
npm 包(Vue2)	@flyfish-group/file-viewer	Vue2.7 组件库，当前 latest 为 1.0.8
GitHub 成品仓库	github.com/flyfish-dev/file-viewer	README、LICENSE、构建产物、示例和可下载 tarball
源码自助开通	https://dev.flyfish.group/shop	付费 4.99 后自助开通源码或二开资源

npm 安装

Vue3

pnpm add @flyfish-group/file-viewer3

import { createApp } from 'vue'
import App from './App.vue'
import FileViewer from '@flyfish-group/file-viewer3'

createApp(App).use(FileViewer).mount('#app')

Vue2.7

pnpm add @flyfish-group/file-viewer

import Vue from 'vue'
import App from './App.vue'
import FileViewer from '@flyfish-group/file-viewer'

Vue.use(FileViewer)

new Vue({
  render: h => h(App)
}).$mount('#app')

成品仓库内容

公开 GitHub 仓库只用于成品交付，不包含当前源码目录。仓库内容通常包括:

• dist/: 混淆压缩后的组件库产物
• demo/: 可独立部署的在线预览器静态站点
• docs/: VitePress 文档静态站点
• example/: 完整样例文件列表
• artifacts/: npm tarball、Demo tarball、文档 tarball
• README.md: 友好的安装、嵌入、下载和授权说明
• LICENSE: 项目许可证

其中 README.md 会承担公开仓库首页职责，写明官方文档、在线 Demo、npm 包、成品目录和源码开通入口。docs/ 则是官方文档站的静态构建产物，可部署到任何静态资源服务中。

公开 GitHub 成品仓库和源码仓库保持分离，源码只在内部仓库维护；公开仓库只保留可直接部署或下载的成品。

发版命令

两条 npm 包线分别在对应分支发布:

技术栈	分支	npm 包
Vue3	v3	@flyfish-group/file-viewer3
Vue2.7	main	@flyfish-group/file-viewer

发布前建议在目标分支执行:

pnpm type-check
pnpm build
pnpm build-lib-only
pnpm obfuscate
pnpm docs:build
npm pack

其中 pnpm obfuscate 会处理 dist/ 中的 .js / .mjs 文件。类型声明、CSS、图片和示例文件不会被混淆，便于业务方正常接入和排查。

正式发布前建议先执行:

npm publish --dry-run --access public

确认包名、版本、README 和 dist/ 文件无误后，再执行 npm publish --access public。如果 npm 账号启用了 MFA，请使用交互式会话完成浏览器确认。

授权和贡献

项目使用 Apache-2.0 许可证。二开或商用时，请保留许可证、版权和来源说明，并注明项目来源为 Flyfish Viewer / @flyfish-group/file-viewer3 或 @flyfish-group/file-viewer。

如果你修复了通用问题或增强了通用能力，建议通过 issue / PR 一起贡献回来。这样后续升级时，大家都能少走一点弯路。