mirror of
https://github.com/andy-stack/vaultkeeper-ai.git
synced 2026-07-22 06:42:03 +00:00
docs: update file format support to include Office/ODF documents
Update documentation across README and Copy.ts to reflect expanded file format support beyond PDFs to include Office (DOCX, PPTX, XLSX) and ODF (ODT, ODP, ODS) documents. Update acknowledgments to credit officeparser and unpdf libraries instead of pdf-parse.
This commit is contained in:
parent
54fd754b24
commit
7c1af608f2
2 changed files with 10 additions and 7 deletions
|
|
@ -176,8 +176,8 @@ If you find any issues or have a feature request, please feel free to raise them
|
|||
##### Operating Modes
|
||||
|
||||
**Read-Only Mode (Default)** - The AI can safely explore your vault:
|
||||
- Search through your notes (including PDF documents)
|
||||
- Read file contents (including binary files like PDFs and images)
|
||||
- Search through your notes (including PDFs and Office/ODF documents)
|
||||
- Read file contents (including binary files like PDFs, Office documents, and images)
|
||||
- List directory structures
|
||||
- Cannot modify anything
|
||||
|
||||
|
|
@ -300,7 +300,7 @@ This error indicates a temporary issue with the AI provider's servers.
|
|||
- **Mistral**: Mistral AI's API
|
||||
|
||||
**What gets sent**:
|
||||
- Your messages and referenced file contents (including binary files like PDFs and images)
|
||||
- Your messages and referenced file contents (including binary files like PDFs, Office documents, and images)
|
||||
- Conversation context (for continuity)
|
||||
- File names and directory structures (when AI searches)
|
||||
|
||||
|
|
|
|||
11
README.md
11
README.md
|
|
@ -21,7 +21,7 @@
|
|||
- **Custom System Instructions** - Create and switch between personalized AI behaviors
|
||||
- **Conversation Management** - Persistent chat history with automatic conversation naming
|
||||
- **Privacy Controls** - Exclude sensitive files and directories from AI access with glob patterns
|
||||
- **Files Support (PDF, Image, etc)** - Search through PDF documents and allow AI to read binary files directly (PDFs, images, etc)
|
||||
- **Files Support (PDF, Documents, Images, etc)** - Search through PDF and Office documents (DOCX, PPTX, XLSX) and allow AI to read binary files directly (PDFs, Office/ODF documents, images, etc)
|
||||
- **Mobile Compatible** - Full functionality on mobile devices with touch-friendly controls
|
||||
- **Streaming Responses** - See AI responses as they're generated
|
||||
- **Local & Private** - API keys stored locally, no data sent to third parties
|
||||
|
|
@ -95,8 +95,8 @@ Switch models anytime in the settings without losing your conversation context.
|
|||
|
||||
**Read-Only Mode (Default)** 🔍
|
||||
|
||||
- AI can search vault content (text based files and PDF documents)
|
||||
- AI can read file contents (including binary files like PDFs and images)
|
||||
- AI can search vault content (text based files, PDFs, and Office/ODF documents)
|
||||
- AI can read file contents (including binary files like PDFs, Office documents, and images)
|
||||
- AI can list directory structures
|
||||
- **Cannot** modify your notes
|
||||
|
||||
|
|
@ -360,6 +360,10 @@ This plugin is built on the shoulders of many excellent projects:
|
|||
- Powered by [Anthropic Claude](https://anthropic.com), [Google Gemini](https://deepmind.google/technologies/gemini/), [OpenAI](https://openai.com), and [Mistral AI](https://mistral.ai)
|
||||
- Official SDKs: [@anthropic-ai/sdk](https://github.com/anthropics/anthropic-sdk-typescript), [@google/genai](https://github.com/google/generative-ai-js), [openai](https://github.com/openai/openai-node)
|
||||
|
||||
**Document Processing**
|
||||
- [unpdf](https://github.com/unjs/unpdf) - PDF parsing and text extraction
|
||||
- [officeparser](https://github.com/nicktomlin/officeparser) - Office document parsing (DOCX, PPTX, XLSX, ODT, ODP, ODS)
|
||||
|
||||
**UI Framework**
|
||||
- [Svelte](https://svelte.dev) - Reactive UI components
|
||||
- [svelte-exmarkdown](https://github.com/ssssota/svelte-exmarkdown) - Markdown rendering for Svelte
|
||||
|
|
@ -382,7 +386,6 @@ This plugin is built on the shoulders of many excellent projects:
|
|||
|
||||
**Utilities**
|
||||
- [fuzzysort](https://github.com/farzher/fuzzysort) - Fuzzy search for reference autocomplete
|
||||
- [pdf-parse](https://github.com/modesty/pdf-parse) - PDF parsing and text extraction
|
||||
- [Zod](https://github.com/colinhacks/zod) - TypeScript-first schema validation
|
||||
- [regex-parser](https://github.com/IonicaBizau/regex-parser.js) - Parses a string as regular expression
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue