Thanks to visit codestin.com
Credit goes to github.com

Skip to content

LYOfficial/OneDocs

Repository files navigation

OneDocs

中文简体 | English

OneDocs

A Single Text, All is Known.

一文亦闻,一款文档智慧分析工具。

阁下若对此项目有所青睐,还请移步右上点亮星标,不胜感谢。

Tauri React Badge TypeScript Badge Markdown Badge LaTeX Badge

文章千卷,一览而知。智慧之器,助君析文明理。

📖 项目简介

OneDocs(一文亦闻)是一款基于 AI 的智能文档分析工具,结合文件解析、大模型应用和输出格式规范化,对用户上传的 PDF 文档进行解构分析,去除无用内容,整理成知识手册。

  • 支持 PDF 文档格式,最大 30 MB
  • 支持 40+ 模型选择(OpenAI / Anthropic / Gemini / 智谱 / DeepSeek / Ollama 等)
  • 支持 Windows / macOS / Linux / Android 跨平台使用
  • 本地运行,无文件上传,不会造成文件和 API Key 泄露
  • 已适配手机版 UI(768px 以下自动切换移动端布局)

📚 更多使用说明请阅读 OneDocs Wiki

✨ 功能介绍

功能 说明
要闻概览 新闻要点梳理
罗森析数 数据内容分析
理工速知 理工课件整理
文采丰呈 文科课件整理

分析结果支持预览、复制 Markdown 源码、导出下载,亦可多文件合并分析。

🖼️ 软件截图

OneDocsOneDocs OneDocsOneDocs OneDocsOneDocs

🛠️ 技术栈

层级 技术
前端框架 React 19 + TypeScript
桌面端 Tauri v2(Rust)
移动端 Tauri v2 Android(APK)
构建工具 Vite 7
状态管理 Zustand 5
PDF 解析 pdfjs-dist v5 + lopdf
渲染 marked(Markdown)+ KaTeX(LaTeX)
国际化 i18next + react-i18next

🚀 开发与构建

环境要求

  • Node.js(推荐 LTS)+ npm
  • Rust + Tauri CLI(桌面端必须)
  • Android SDK + NDK(仅 Android 构建需要)

Tauri 版本说明

请固定使用当前仓库已验证的版本组合,使用精确版本(不要使用 ^):

npm 版本 Rust 版本
api / cli 2.6.0
tauri / tauri-build =2.6.0
tauri-runtime =2.9.2
plugin-dialog 2.3.0 =2.3.0
plugin-fs 2.4.0 =2.4.0
plugin-shell 2.3.0 =2.3.0

如需升级 Tauri,请保持 npm 与 Rust 端同一代版本并重新验证。

桌面端

npm install
npm run dev          # Web 前端开发
npm run tauri:dev    # Tauri 桌面端开发

# 构建发行版
npm run tauri:build                    # NSIS + MSI
npx tauri build --bundles nsis         # 仅 NSIS(推荐)

构建产物位于 src-tauri/target/release/bundle/

Android APK

👉 详细的 Android 构建步骤请参阅 docs/BUILD_ANDROID.md

快速开始:

npm run android:init          # 初始化 Android 项目(仅需一次)
npm run android:dev           # 开发模式
npm run android:build         # 构建签名 APK(通用)
npm run android:build:split   # 按架构拆分(体积更小)

重置开发状态

// DevTools Console 中执行
localStorage.removeItem('onedocs-storage')  // 重置引导
localStorage.clear()                         // 清除所有状态

📦 CI/CD

项目使用 GitHub Actions 自动构建发行版:

  • 桌面端.github/workflows/release.yml):推送 v* 标签或手动触发,构建 Windows / macOS / Linux 安装包
  • Android.github/workflows/android.yml):手动触发,构建签名 APK + AAB 并发布到 GitHub Releases

🤝 贡献指南

欢迎通过 Pull RequestGitHub Issues 参与贡献。

  • 提交 PR 时请包含:变更摘要、验证步骤、UI 变更截图或录屏
  • Commit 信息请保持简明,可使用 feat: / fix: / docs: 等前缀

📄 版权声明

版权所有 © 2024-2026 LYOfficial。本项目基于 GNU 通用公共许可证 v3.0 发布。

🙏 鸣谢

  • Tauri — 跨平台应用框架
  • lopdf — Rust PDF 处理库
  • pdfjs-dist — PDF 文本解析
  • React — 用户界面构建库
  • marked — Markdown 解析器
  • KaTeX — LaTeX 数学公式渲染
  • Zustand — 轻量状态管理
  • i18next — 国际化框架

糖方科技提供苹果软件签名

candyrectangle

👥 作者

  • @LYOfficial — 主要开发,项目主管
  • @JHL-HK — 部分重构,macOS 适配,i18n 支持

⭐ Star 里程图

Star History Chart