Skip to content

Commit 38f4cb1

Browse files
committed
docs: update feature overview
1 parent 03e46fc commit 38f4cb1

4 files changed

Lines changed: 40 additions & 24 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@
3232

3333
- **Two-Step Chain-of-Thought Ingest** — LLM analyzes first, then generates wiki pages with source traceability and incremental cache
3434
- **Multimodal Image Ingestion** — extract embedded images from PDFs, generate factual captions with a vision LLM, surface them in image-aware search results with lightbox preview and jump-to-source
35-
- **Optional MinerU PDF Parsing** — use MinerU cloud parsing for complex PDFs with tables, formulas, and dense layouts; the built-in local parser remains the default
35+
- **Multi-format Document Parsing** — ingest PDF, Office documents, EPUB/MOBI, images, media, and web clips, with built-in, cloud, or local MinerU PDF processing
36+
- **Project Management & Migration** — export and import complete project archives across devices, and rebuild the Wiki index from existing pages
3637
- **4-Signal Knowledge Graph** — relevance model with direct links, source overlap, Adamic-Adar, and type affinity
3738
- **Louvain Community Detection** — automatic knowledge cluster discovery with cohesion scoring
3839
- **Graph Insights** — surprising connections and knowledge gaps with one-click Deep Research
@@ -320,15 +321,16 @@ The original focuses on text/markdown. We support structured extraction preservi
320321

321322
| Format | Method |
322323
|--------|--------|
323-
| PDF | Built-in pdf-extract (Rust) with file caching; optional MinerU cloud parsing for tables, formulas, and complex layouts |
324+
| PDF | Built-in pdf-extract (Rust) with file caching; optional MinerU Cloud, Local API, or Pipeline parsing for complex layouts |
324325
| DOCX | docx-rs — headings, bold/italic, lists, tables → structured Markdown |
325326
| PPTX | ZIP + XML — slide-by-slide extraction with heading/list structure |
326327
| XLSX/XLS/ODS | calamine — proper cell types, multi-sheet support, Markdown tables |
328+
| EPUB/MOBI | Electronic book metadata, chapters, and body text → ingest-ready content |
327329
| Images | Native preview (png, jpg, gif, webp, svg, etc.) |
328330
| Video/Audio | Built-in player |
329331
| Web clips | Readability.js + Turndown.js → clean Markdown |
330332

331-
> MinerU is optional. When enabled, PDF files are uploaded to MinerU cloud for parsing; keep the built-in parser for sensitive documents. If MinerU fails, LLM Wiki falls back to the built-in parser. MinerU usage is subject to its file size, page count, and quota limits.
333+
> MinerU is optional. Use MinerU Cloud, an official Local API endpoint, or Local Pipeline mode for complex PDFs. Local modes keep processing on your machine, and extracted images are stored in the project-managed `wiki/media` directory. If MinerU fails, LLM Wiki falls back to the built-in parser.
332334
333335
### 16. File Deletion with Cascade Cleanup
334336

@@ -366,7 +368,10 @@ The original is platform-agnostic (abstract pattern). We handle concrete cross-p
366368
- **Obsidian config** — auto-generated `.obsidian/` directory with recommended settings
367369
- **Markdown rendering** — GFM tables with borders, proper code blocks, wikilink processing in chat and preview
368370
- **Multi-provider LLM support** — OpenAI, Anthropic, Google, Ollama, Custom — each with provider-specific streaming and headers
369-
- **15-minute timeout** — long ingest operations won't fail prematurely
371+
- **Configurable LLM timeout** — adjust request timeouts for slow local models and long-running operations
372+
- **Configurable Firecrawl** — optional API key and custom Base URL for hosted or self-hosted services
373+
- **Collapsible file sidebar** — collapse Knowledge/Files navigation while preserving its state
374+
- **Project maintenance** — ZIP export/import for migration and deterministic `wiki/index.md` rebuilding
370375
- **dataVersion signaling** — graph and UI automatically refresh when wiki content changes
371376

372377
## Tech Stack
@@ -380,8 +385,7 @@ The original is platform-agnostic (abstract pattern). We handle concrete cross-p
380385
| Graph | sigma.js + graphology + ForceAtlas2 |
381386
| Search | Tokenized search + graph relevance + optional vector (LanceDB) |
382387
| Vector DB | LanceDB (Rust, embedded, optional) |
383-
| PDF | pdf-extract + optional MinerU cloud parser |
384-
| Office | docx-rs + calamine |
388+
| Documents | pdf-extract + MinerU Cloud/Local + docx-rs + calamine + EPUB/MOBI extraction |
385389
| i18n | react-i18next |
386390
| State | Zustand |
387391
| LLM | Streaming fetch (OpenAI, Anthropic, Google, Ollama, Custom) |

README_CN.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@
3232

3333
- **两步思维链摄入** — LLM 先分析再生成 Wiki 页面,来源可追溯,支持增量缓存
3434
- **多模态图片摄入** — 自动提取 PDF 内嵌图片,调用视觉模型生成事实性描述,搜索结果按图文分区,支持 lightbox 预览与跳转到原始文档对应位置
35-
- **可选 MinerU PDF 解析** — 可启用 MinerU 云端解析复杂 PDF(表格、公式、密集排版),默认仍使用内置本地解析
35+
- **多格式文档解析** — 支持 PDF、Office 文档、EPUB/MOBI、图片、音视频和网页剪藏,并提供内置、云端或本地 MinerU PDF 处理
36+
- **项目管理与迁移** — 支持完整项目归档的跨设备导入导出,并可根据现有 Wiki 页面重建索引
3637
- **四信号知识图谱** — 直接链接、来源重叠、Adamic-Adar、类型亲和四维关联度模型
3738
- **Louvain 社区检测** — 自动发现知识聚类,内聚度评分
3839
- **图谱洞察** — 惊奇连接与知识空白检测,一键触发 Deep Research
@@ -320,15 +321,16 @@ LLM Wiki 是一个跨平台桌面应用,能将你的文档自动转化为有
320321

321322
| 格式 | 方法 |
322323
|------|------|
323-
| PDF | 内置 pdf-extract(Rust)+ 文件缓存;可选 MinerU 云端解析表格、公式和复杂排版 |
324+
| PDF | 内置 pdf-extract(Rust)+ 文件缓存;可选 MinerU 云端、Local API 或 Pipeline 模式解析复杂排版 |
324325
| DOCX | docx-rs —— 标题、加粗/斜体、列表、表格 → 结构化 Markdown |
325326
| PPTX | ZIP + XML —— 逐页提取,保留标题/列表结构 |
326327
| XLSX/XLS/ODS | calamine —— 正确的单元格类型、多工作表支持、Markdown 表格 |
328+
| EPUB/MOBI | 提取电子书元数据、章节和正文,转换为可摄取内容 |
327329
| 图片 | 原生预览(png, jpg, gif, webp, svg 等) |
328330
| 视频/音频 | 内置播放器 |
329331
| 网页剪藏 | Readability.js + Turndown.js → 干净的 Markdown |
330332

331-
> MinerU 是可选功能。启用后 PDF 文件会上传到 MinerU 云端解析;敏感文档建议继续使用内置本地解析。若 MinerU 解析失败,LLM Wiki 会回退到内置解析。MinerU 使用受其文件大小、页数和额度限制约束
333+
> MinerU 是可选功能。复杂 PDF 可使用 MinerU 云端、官方 Local API 或本地 Pipeline 模式;本地模式无需上传文件,提取的图片会保存到项目管理的 `wiki/media` 目录。若 MinerU 失败,LLM Wiki 会回退到内置解析器
332334
333335
### 16. 文件删除级联清理
334336

@@ -366,7 +368,10 @@ LLM Wiki 是一个跨平台桌面应用,能将你的文档自动转化为有
366368
- **Obsidian 配置** —— 自动生成 `.obsidian/` 目录及推荐设置
367369
- **Markdown 渲染** —— 带边框的 GFM 表格、代码块、聊天和预览中的 wikilink 处理
368370
- **多 LLM 提供商** —— OpenAI、Anthropic、Google、Ollama、自定义 —— 各有特定的流式传输和请求头
369-
- **15 分钟超时** —— 长时间摄入操作不会过早失败
371+
- **可配置 LLM 超时** —— 可针对较慢的本地模型和长任务调整请求超时
372+
- **可配置 Firecrawl** —— 支持可选 API Key 和自定义 Base URL,可连接托管或自部署服务
373+
- **可折叠文件侧栏** —— 可收起 Knowledge/Files 导航并保存折叠状态
374+
- **项目维护** —— 支持 ZIP 导入导出迁移和确定性重建 `wiki/index.md`
370375
- **dataVersion 信号** —— 图谱和 UI 在 Wiki 内容变更时自动刷新
371376

372377
## 技术栈
@@ -380,8 +385,7 @@ LLM Wiki 是一个跨平台桌面应用,能将你的文档自动转化为有
380385
| 图谱 | sigma.js + graphology + ForceAtlas2 |
381386
| 搜索 | 分词搜索 + 图谱关联度 + 可选向量(LanceDB) |
382387
| 向量数据库 | LanceDB(Rust,嵌入式,可选) |
383-
| PDF | pdf-extract + 可选 MinerU 云端解析 |
384-
| Office | docx-rs + calamine |
388+
| 文档解析 | pdf-extract + MinerU 云端/本地 + docx-rs + calamine + EPUB/MOBI 提取 |
385389
| 国际化 | react-i18next |
386390
| 状态管理 | Zustand |
387391
| LLM | 流式 fetch(OpenAI、Anthropic、Google、Ollama、自定义) |

README_JA.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@
3232

3333
- **2 段階 Chain-of-Thought インジェスト** — LLM がまず分析を行い、その後ソース追跡可能な Wiki ページを生成。増分キャッシュ対応
3434
- **マルチモーダル画像インジェスト** — PDF 内の埋め込み画像を抽出し、Vision LLM で事実ベースのキャプションを生成。画像対応の検索結果、ライトボックスプレビュー、元資料の該当位置へのジャンプに対応
35-
- **任意の MinerU PDF 解析** — 表、数式、複雑なレイアウトを含む PDF には MinerU クラウド解析を利用可能。既定では内蔵ローカル解析を使用
35+
- **マルチフォーマット文書解析** — PDF、Office 文書、EPUB/MOBI、画像、メディア、Web クリップに対応し、内蔵・クラウド・ローカル MinerU による PDF 処理を選択可能
36+
- **プロジェクト管理と移行** — 完全なプロジェクトアーカイブを端末間でインポート/エクスポートし、既存 Wiki ページからインデックスを再構築可能
3637
- **4 シグナル知識グラフ** — 直接リンク、ソース重複、Adamic-Adar、タイプ親和性による関連度モデル
3738
- **Louvain コミュニティ検出** — 知識クラスタを自動発見し、凝集度を評価
3839
- **グラフインサイト** — 意外な関連や知識の空白を検出し、ワンクリックで Deep Research を起動
@@ -328,15 +329,16 @@ LLM Wiki は、手元の文書を整理された相互リンク付きの知識
328329

329330
| フォーマット | 抽出方法 |
330331
|--------------|----------|
331-
| PDF | 内蔵 pdf-extract(Rust)+ ファイルキャッシュ。表、数式、複雑なレイアウト向けに MinerU クラウド解析を任意で利用可能 |
332+
| PDF | 内蔵 pdf-extract(Rust)+ ファイルキャッシュ。複雑なレイアウト向けに MinerU Cloud、Local API、Pipeline を任意で利用可能 |
332333
| DOCX | docx-rs — 見出し、太字/斜体、リスト、テーブルを構造化 Markdown へ |
333334
| PPTX | ZIP + XML — スライド単位で抽出し、見出し/リスト構造を保持 |
334335
| XLSX/XLS/ODS | calamine — 正しいセル型、複数シート対応、Markdown テーブルに変換 |
336+
| EPUB/MOBI | 電子書籍のメタデータ、章、本文を抽出し、インジェスト可能なコンテンツへ変換 |
335337
| 画像 | ネイティブプレビュー(png, jpg, gif, webp, svg など) |
336338
| 動画/音声 | 内蔵プレイヤー |
337339
| Web クリップ | Readability.js + Turndown.js → クリーンな Markdown |
338340

339-
> MinerU は任意機能です。有効にすると PDF ファイルは解析のため MinerU クラウドへアップロードされます。機密文書には内蔵ローカル解析の利用を推奨します。MinerU 解析に失敗した場合、LLM Wiki は内蔵解析へフォールバックします。MinerU の利用はファイルサイズ、ページ数、クォータ制限の対象です
341+
> MinerU は任意機能です。複雑な PDF には MinerU Cloud、公式 Local API、またはローカル Pipeline モードを利用できます。ローカルモードではファイルを外部へ送信せず、抽出画像はプロジェクト管理下の `wiki/media` に保存されます。失敗時は内蔵解析へフォールバックします
340342
341343
### 16. ファイル削除のカスケードクリーンアップ
342344

@@ -374,7 +376,10 @@ LLM Wiki は、手元の文書を整理された相互リンク付きの知識
374376
- **Obsidian 設定** — 推奨設定入りの `.obsidian/` ディレクトリを自動生成
375377
- **Markdown レンダリング** — 枠線付きの GFM テーブル、整形されたコードブロック、チャットとプレビュー内での wikilink 処理
376378
- **マルチプロバイダー LLM 対応** — OpenAI、Anthropic、Google、Ollama、カスタム。プロバイダーごとにストリーミングとヘッダーを調整
377-
- **15 分タイムアウト** — 長時間のインジェスト処理が早すぎる段階で失敗しないようにする
379+
- **設定可能な LLM タイムアウト** — 遅いローカルモデルや長時間処理に合わせてリクエスト時間を調整
380+
- **設定可能な Firecrawl** — API キーとカスタム Base URL により、ホスト型・セルフホスト型の両方に対応
381+
- **折りたたみ可能なファイルサイドバー** — Knowledge/Files ナビゲーションを折りたたみ、状態を保持
382+
- **プロジェクト保守** — ZIP による移行用インポート/エクスポートと `wiki/index.md` の再構築
378383
- **dataVersion シグナル** — Wiki コンテンツの変更に合わせてグラフと UI を自動リフレッシュ
379384

380385
## 技術スタック
@@ -388,8 +393,7 @@ LLM Wiki は、手元の文書を整理された相互リンク付きの知識
388393
| グラフ | sigma.js + graphology + ForceAtlas2 |
389394
| 検索 | トークン化検索 + グラフ関連度 + 任意のベクトル検索(LanceDB) |
390395
| ベクトル DB | LanceDB(Rust、組み込み、オプション) |
391-
| PDF | pdf-extract + 任意の MinerU クラウド解析 |
392-
| Office | docx-rs + calamine |
396+
| 文書解析 | pdf-extract + MinerU Cloud/Local + docx-rs + calamine + EPUB/MOBI 抽出 |
393397
| 多言語対応 | react-i18next |
394398
| 状態管理 | Zustand |
395399
| LLM | ストリーミング fetch(OpenAI、Anthropic、Google、Ollama、カスタム) |

README_KO.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@
3232

3333
- **2단계 Chain-of-Thought 인제스트** — LLM이 먼저 분석한 뒤, 출처 추적성과 증분 캐시를 갖춘 Wiki 페이지를 생성합니다
3434
- **멀티모달 이미지 인제스트** — PDF에 포함된 이미지를 추출하고, Vision LLM으로 사실 기반 캡션을 생성하며, 이미지 인식 검색 결과와 라이트박스 미리보기, 원본 위치로 이동 기능을 제공합니다
35-
- **선택적 MinerU PDF 파싱** — 표, 수식, 복잡한 레이아웃이 있는 PDF에는 MinerU 클라우드 파싱을 사용할 수 있으며, 기본값은 내장 로컬 파서입니다
35+
- **다중 형식 문서 파싱** — PDF, Office 문서, EPUB/MOBI, 이미지, 미디어, 웹 클립을 지원하며 내장, 클라우드 또는 로컬 MinerU PDF 처리를 선택할 수 있습니다
36+
- **프로젝트 관리 및 마이그레이션** — 전체 프로젝트 아카이브를 장치 간에 가져오고 내보내며 기존 Wiki 페이지에서 인덱스를 다시 만들 수 있습니다
3637
- **4-신호 지식 그래프** — 직접 링크, 출처 중복, Adamic-Adar, 타입 친화도를 사용하는 관련성 모델입니다
3738
- **Louvain 커뮤니티 감지** — 지식 클러스터를 자동으로 발견하고 응집도를 점수화합니다
3839
- **그래프 인사이트** — 뜻밖의 연결과 지식 공백을 찾아내고, 한 번의 클릭으로 Deep Research를 실행합니다
@@ -328,15 +329,16 @@ LLM Wiki는 문서를 자동으로 정리되고 서로 연결된 지식 베이
328329

329330
| 형식 | 방식 |
330331
|------|------|
331-
| PDF | 파일 캐싱이 포함된 내장 pdf-extract(Rust); 표, 수식, 복잡한 레이아웃에는 선택적으로 MinerU 클라우드 파싱 사용 |
332+
| PDF | 파일 캐싱이 포함된 내장 pdf-extract(Rust); 복잡한 레이아웃에는 MinerU Cloud, Local API 또는 Pipeline 모드 사용 가능 |
332333
| DOCX | docx-rs — headings, bold/italic, lists, tables → 구조화된 Markdown |
333334
| PPTX | ZIP + XML — slide-by-slide extraction with heading/list structure |
334335
| XLSX/XLS/ODS | calamine — proper cell types, multi-sheet support, Markdown tables |
336+
| EPUB/MOBI | 전자책 메타데이터, 장, 본문을 추출해 인제스트 가능한 콘텐츠로 변환 |
335337
| Images | Native preview(png, jpg, gif, webp, svg 등) |
336338
| Video/Audio | 내장 player |
337339
| Web clips | Readability.js + Turndown.js → clean Markdown |
338340

339-
> MinerU는 선택 기능입니다. 활성화하면 PDF 파일이 파싱을 위해 MinerU 클라우드로 업로드됩니다. 민감한 문서는 내장 로컬 파서를 사용하는 것을 권장합니다. MinerU 파싱이 실패하면 LLM Wiki는 내장 파서로 자동 fallback합니다. MinerU 사용에는 파일 크기, 페이지 수, quota 제한이 적용됩니다.
341+
> MinerU는 선택 기능입니다. 복잡한 PDF에는 MinerU Cloud, 공식 Local API 또는 로컬 Pipeline 모드를 사용할 수 있습니다. 로컬 모드는 파일을 외부로 전송하지 않으며 추출된 이미지는 프로젝트가 관리하는 `wiki/media`에 저장됩니다. 실패하면 내장 파서로 fallback합니다.
340342
341343
### 16. Cascade Cleanup을 포함한 파일 삭제
342344

@@ -374,7 +376,10 @@ LLM Wiki는 문서를 자동으로 정리되고 서로 연결된 지식 베이
374376
- **Obsidian 설정** — 권장 설정이 포함된 `.obsidian/` 디렉터리 자동 생성
375377
- **Markdown 렌더링** — 테두리가 있는 GFM tables, 적절한 code blocks, chat과 preview의 wikilink processing
376378
- **다중 provider LLM 지원** — OpenAI, Anthropic, Google, Ollama, Custom. 각각 provider별 streaming과 header를 지원합니다
377-
- **15분 timeout** — 긴 인제스트 작업이 너무 일찍 실패하지 않습니다
379+
- **설정 가능한 LLM timeout** — 느린 로컬 모델과 장시간 작업에 맞춰 요청 제한 시간을 조정할 수 있습니다
380+
- **설정 가능한 Firecrawl** — 선택적 API key와 custom Base URL로 hosted 및 self-hosted 서비스를 지원합니다
381+
- **접을 수 있는 파일 사이드바** — Knowledge/Files 탐색을 접고 상태를 유지합니다
382+
- **프로젝트 유지관리** — ZIP 가져오기/내보내기 마이그레이션과 `wiki/index.md` 재구축을 지원합니다
378383
- **dataVersion signaling** — Wiki 콘텐츠가 변경되면 그래프와 UI가 자동 새로고침됩니다
379384

380385
## 기술 스택
@@ -388,8 +393,7 @@ LLM Wiki는 문서를 자동으로 정리되고 서로 연결된 지식 베이
388393
| Graph | sigma.js + graphology + ForceAtlas2 |
389394
| Search | Tokenized search + graph relevance + optional vector(LanceDB) |
390395
| Vector DB | LanceDB(Rust, embedded, optional) |
391-
| PDF | pdf-extract + 선택적 MinerU 클라우드 파서 |
392-
| Office | docx-rs + calamine |
396+
| 문서 파싱 | pdf-extract + MinerU Cloud/Local + docx-rs + calamine + EPUB/MOBI 추출 |
393397
| i18n | react-i18next |
394398
| State | Zustand |
395399
| LLM | Streaming fetch(OpenAI, Anthropic, Google, Ollama, Custom) |

0 commit comments

Comments
 (0)