diff --git a/README.md b/README.md index 70393b2..efbb176 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@
+Toolkit Logo -# Obsidian Toolkit +# My Toolkit **An all-in-one productivity suite for Obsidian** @@ -14,33 +15,34 @@ Seven integrated modules — formatting, AI, image control, navigation, and focu --- -## Features at a glance +## Modules at a glance -| Module | Description | Shortcut | -|--------|-------------|----------| -| 🎨 Formatting Palette | 60+ formatting elements in a searchable palette | `Ctrl+Shift+F` | -| 🤖 AI Smart Suggestion | One-line continuation based on context | `Ctrl+Shift+G` | -| 📐 AI Template Generator | Full structured templates from a description | `Ctrl+Shift+T` | -| 🖼 Image Control | Click-activated toolbar: resize, align, rotate, lightbox | Reading View | -| ⛶ Fullscreen Note | Distraction-free writing + auto-fullscreen | `Ctrl+Shift+Z` | -| 🌳 Premium File Tree | SF Symbols-style icons + image thumbnails | Sidebar | -| ⚡ Quick Access Bar | Pinned one-click buttons above the file tree | Sidebar | -| 📁 Folder Focus Mode | Zoom into a folder — it becomes the visual vault root | Right-click | +| | Module | Description | Shortcut | +|-|--------|-------------|----------| +| 🎨 | Formatting Palette | 60+ elements in a searchable palette | `Ctrl+Shift+F` | +| 🤖 | AI Smart Suggestion | One-line continuation from context | `Ctrl+Shift+G` | +| 📐 | AI Template Generator | Full structured templates from a description | `Ctrl+Shift+T` | +| 🖼 | Image Control | Resize, align, rotate, caption, lightbox | Reading View | +| ⛶ | Fullscreen Note | Distraction-free writing + auto-fullscreen | `Ctrl+Shift+Z` | +| 🌳 | Premium File Tree | SF Symbols-style icons + image thumbnails | Sidebar | +| ⚡ | Quick Access Bar | Pinned one-click buttons above the file tree | Sidebar | +| 📁 | Folder Focus Mode | Zoom into a folder — hide everything else | Right-click | --- ## 🎨 Formatting Palette -A searchable command palette with 60+ formatting elements organised by category. +Press `Ctrl+Shift+F` to open. Use `↑↓` to navigate, `Enter` to insert, `Esc` to close. -Press `Ctrl+Shift+F` (or click the wand icon in the ribbon) to open it. Use `↑↓` to navigate, `Enter` to insert, `Esc` to close. +Formatting Palette -1 +**Categories:** Insert · Callouts · Custom Callouts · Islamic (RTL) · Headings · Text · Lists · Code · Dividers +
+Full category breakdown -**Categories:** - **Insert** — Dates, times, progress bar generator, AI smart suggestion, AI template generator -- **Callouts** — All 12 built-in Obsidian callouts (note, tip, warning, danger, bug…) +- **Callouts** — All 12 built-in callouts (note, tip, warning, danger, bug…) - **Custom Callouts** — Goal, Idea, Task, Formula, Remember, Blocker, Command, Config… - **Islamic** — Ayah, Hadith, Dua with RTL layout and Arabic typography - **Headings** — H1–H5 @@ -49,47 +51,54 @@ Press `Ctrl+Shift+F` (or click the wand icon in the ribbon) to open it. Use `↑ - **Code** — Code block, math block - **Dividers** — Line, double, dots, arrow, wave, dashed +
+ --- ## 🤖 AI Provider Connect any OpenAI-compatible API — or run models locally for free with Ollama. -2 - **Supported providers:** -- **Ollama** (local, free) — auto-fetches your installed models -- **OpenAI** — gpt-4o-mini, gpt-4o… -- **Custom** — OpenRouter, Groq, Anthropic proxy, or any `/v1/chat/completions` endpoint -**Configure:** Settings → Obsidian Toolkit → 🤖 AI Provider -55 +| Provider | Notes | +|----------|-------| +| **Ollama** | Local, free — auto-fetches your installed models | +| **OpenAI** | gpt-4o-mini, gpt-4o… | +| **Custom** | OpenRouter, Groq, Anthropic proxy, or any `/v1/chat/completions` endpoint | +AI Settings ### AI Smart Suggestion `Ctrl+Shift+G` -Reads the last 12 lines of context (or your selection) and suggests a single continuation — a callout, heading, checklist, or paragraph that fits what you're writing. +Reads the last 12 lines of context (or your selection) and suggests a single continuation — a callout, heading, checklist, or paragraph. ### AI Template Generator `Ctrl+Shift+T` -Describe what you want to create and the AI generates a complete, structured markdown template: +Describe what you want to create, and the AI generates a complete structured markdown template. -> *"Weekly meeting notes with action items"* +> **Example:** *"Weekly meeting notes with action items"* > → Full template with headings, callouts, checklists, and placeholders -2 +AI Template Generator -Optional extra instructions: *"Use Arabic headings"*, *"Keep it short"*, *"Include a progress bar"* +AI Smart Suggestion + +
+Ollama setup -**Setting up Ollama:** ```bash # Install: https://ollama.com ollama pull qwen2.5:3b ollama serve + # If you get a CORS error: OLLAMA_ORIGINS="app://obsidian.md*" ollama serve ``` -Then: Settings → AI Provider → Ollama → **Fetch models** → select model → **Test Connection** + +Then: **Settings → AI Provider → Ollama → Fetch models → select model → Test Connection** + +
--- @@ -97,6 +106,8 @@ Then: Settings → AI Provider → Ollama → **Fetch models** → select model Click any image in Reading View to reveal a floating toolbar. +Image Control toolbar + | Button | Action | |--------|--------| | `−` / `+` | Resize by 30 px steps | @@ -104,85 +115,89 @@ Click any image in Reading View to reveal a floating toolbar. | `↻` | Rotate 90° | | `✎` | Add a caption | | `⟲` | Reset to original size and position | -| `⎘` | Copy Obsidian markdown link with current width | -| `⤢` | Open fullscreen lightbox (pan, zoom, rotate) | +| `⎘` | Copy markdown link with current width | +| `⤢` | Open fullscreen lightbox (pan · zoom · rotate) | -image - -**Special layouts** — add these CSS classes to a `div` wrapping images in your markdown: +
+Special layout classes ```html -
...images...
-
...image + text...
-
...image + em...
+
...
+
...
+
...
+
...
+
...
+
...
``` +
+ --- ## ⛶ Fullscreen Note -Floating fullscreen button (`⛶`) appears on every note. Toggle with `Ctrl+Shift+Z`. -3 +Floating `⛶` button on every note. Toggle with `Ctrl+Shift+Z`. -**Auto-fullscreen:** Enable in settings to automatically enter fullscreen after a configurable inactivity period (5–120 seconds). A soft hint bar appears 3 seconds before with a Cancel button. +Fullscreen button -5 +**Auto-fullscreen:** Enters fullscreen automatically after a configurable inactivity period (5–120 s). A soft hint bar with a Cancel button appears 3 seconds before. + +Auto-fullscreen hint bar + +Fullscreen settings --- ## 🌳 Premium File Tree -Apple-style SF Symbols-inspired icons for every file type in the file explorer — Markdown, PDF, Image, Video, Audio, Code, Archive, Canvas, Link, and plain text. -8 +Apple-style SF Symbols-inspired icons for every file type — Markdown, PDF, Image, Video, Audio, Code, Archive, Canvas, Link, and plain text. Image files show a real 18×18 px thumbnail. -Image files display a real 18×18 px thumbnail in the tree. +Premium File Tree icons -**Row height:** Compact / Default / Spacious — configurable in settings. -3 2 +**Row height:** Compact / Default / Spacious + +File Tree row height settings --- ## ⚡ Quick Access Bar -A persistent bar of pinned buttons above the file tree. Each button opens a specific note or folder with one click. +A persistent bar of pinned buttons above the file tree. One click opens any note or folder. -**Add items:** -- **"+ Add current file"** — pins the file currently open in the editor -- **"+ Add current folder"** — pins its parent folder -- **Manual path** — type any vault-relative path -6 +Quick Access Bar in sidebar -4 +Quick Access Bar settings + +**Add items:** `+ Add current file` · `+ Add current folder` · manual path input --- ## 📁 Folder Focus Mode -Right-click any folder → **"📁 Focus on this folder"** — the sidebar shows only that folder's contents, with everything else hidden. Sub-folders start collapsed. +Right-click any folder → **"📁 Focus on this folder"** — the sidebar shows only that folder's contents. Everything else is hidden. Sub-folders start collapsed. A back button ("← All files") appears at the top to exit. -A back button ("← All files") appears at the top to exit focus. +Folder Focus Mode -**Main Folders** (Settings → Folder Focus Mode): define a list of top-level folders that appear as **tabs** in a persistent bar above the tree. One click on a tab → instant focus. Click again → exit. -7 +**Main Folders tabs:** Define top-level folders in Settings — they appear as tabs in a persistent bar above the tree. One click to focus, one click to exit. -> Note: Search, Graph View, and Quick Switcher (`Ctrl+O`) always cover the full vault regardless of focus state. +> Search, Graph View, and Quick Switcher (`Ctrl+O`) always cover the full vault regardless of focus state. --- ## Installation -### From Obsidian Community Plugins *(coming soon)* -Settings → Community Plugins → Browse → search **Obsidian Toolkit** → Install → Enable +### From Community Plugins *(coming soon)* +Settings → Community Plugins → Browse → search **My Toolkit** → Install → Enable ### Via BRAT *(available now)* -1. Install the [BRAT](https://github.com/TfTHacker/obsidian42-brat) plugin -2. BRAT → Add Beta Plugin → enter `ahmdmusa/obsidian-toolkit` +1. Install [BRAT](https://github.com/TfTHacker/obsidian42-brat) +2. BRAT → Add Beta Plugin → `ahmdmusa/obsidian-toolkit` 3. Enable the plugin ### Manual 1. Download `main.js`, `styles.css`, `manifest.json` from [Releases](https://github.com/ahmdmusa/obsidian-toolkit/releases/latest) -2. Copy to `/.obsidian/plugins/obsidian-toolkit/` -3. Quit and reopen Obsidian → Settings → Community Plugins → enable **Obsidian Toolkit** +2. Copy to `/.obsidian/plugins/ahmed-toolkit/` +3. Restart Obsidian → Settings → Community Plugins → enable **My Toolkit** --- @@ -190,12 +205,12 @@ Settings → Community Plugins → Browse → search **Obsidian Toolkit** → In | Shortcut | Action | |----------|--------| -| `Ctrl+Shift+F` | Open Formatting Palette | +| `Ctrl+Shift+F` | Formatting Palette | | `Ctrl+Shift+Z` | Toggle Fullscreen | | `Ctrl+Shift+G` | AI Smart Suggestion | | `Ctrl+Shift+T` | AI Template Generator | -All shortcuts can be changed in Settings → Hotkeys. +All shortcuts are remappable in Settings → Hotkeys. --- @@ -205,89 +220,118 @@ All shortcuts can be changed in Settings → Hotkeys. |---------|-------------| | 🎨 Formatting Palette | Enable / disable | | 🖼 Image Control | Enable / disable | -| ⛶ Fullscreen Note | Enable, auto-fullscreen toggle, inactivity timer (5–120 s) | -| 🤖 AI Provider | Provider, model selector (Ollama: auto-fetch), API key, response language, custom system prompt | +| ⛶ Fullscreen Note | Enable, auto-fullscreen, inactivity timer (5–120 s) | +| 🤖 AI Provider | Provider, model (auto-fetch for Ollama), API key, response language, system prompt | | 🌳 Premium File Tree | Enable, image thumbnails, row height | -| ⚡ Quick Access Bar | Enable, manage pinned items (reorder, remove) | -| 📁 Folder Focus Mode | Enable, manage main folder tabs (reorder with ↑↓, remove) | +| ⚡ Quick Access Bar | Enable, manage pinned items | +| 📁 Folder Focus Mode | Enable, manage main folder tabs (↑↓ to reorder) | --- ## Compatibility -- Obsidian `0.15.0` or later -- Desktop and mobile (Image Control and Fullscreen are desktop-optimised) +- Obsidian 0.15.0 or later +- Desktop and mobile - Works with any community theme --- +## Screenshots + +
+ + + + + + + + + + + + + + + + + + +
+ +**🎨 Formatting Palette** +لوحة التنسيق + + + +**🤖 AI Template Generator** +مولّد القوالب + +
+ +**⛶ Fullscreen Note** +ملء الشاشة التلقائي + + + +**🤖 AI Provider Settings** +إعدادات الذكاء الاصطناعي + +
+ +**🌳 Premium File Tree** +شجرة الملفات + + + +**⚡ Quick Access Bar** +شريط الوصول السريع + +
+ +**📁 Folder Focus Mode** +وضع التركيز على فولدر + + + +**⚡ Quick Access Bar Sidebar** +شريط الوصول السريع - الشريط الجانبي + +
+ +
+ ---
-# Obsidian Toolkit — ع -**مجموعة أدوات متكاملة لـ Obsidian — سبع وحدات في إضافة واحدة** +**مجموعة أدوات متكاملة — سبع وحدات في إضافة واحدة** ---- +| الوحدة | الوصف | +|--------|-------| +| 🎨 لوحة التنسيق | أكثر من 60 عنصر — Callouts، إسلاميات، عناوين، فواصل | +| 🤖 الذكاء الاصطناعي | اقتراح ذكي ومولّد قوالب كاملة | +| 🖼 التحكم في الصور | تكبير، محاذاة، تدوير، lightbox بالنقر | +| ⛶ ملء الشاشة | زر عائم + دخول تلقائي بعد فترة خمول | +| 🌳 شجرة الملفات | أيقونات SF Symbols + صور مصغّرة | +| ⚡ شريط الوصول السريع | أزرار ثابتة فوق الشجرة لأي ملف أو فولدر | +| 📁 وضع التركيز | كليك يمين على فولدر → يصبح جذر الـ sidebar | -## المميزات +### التثبيت عبر BRAT +``` +ahmdmusa/obsidian-toolkit +``` -### 🎨 لوحة التنسيق — `Ctrl+Shift+F` -أكثر من 60 عنصر تنسيق في لوحة بحث سريعة: Callouts مدمجة ومخصصة، إسلاميات (آيات وأحاديث وأدعية) بتنسيق RTL، عناوين، نصوص، قوائم، كود، فواصل — كل حاجة في مكان واحد. +### التثبيت اليدوي +انسخ الملفات إلى: `/.obsidian/plugins/ahmed-toolkit/` + +
+ +--- + +
+ +MIT License · Ahmed Mousa · [GitHub](https://github.com/ahmdmusa) · [LinkedIn](https://www.linkedin.com/in/ahmdmusa) · Egypt 🇪🇬 -### 🤖 الذكاء الاصطناعي -**اقتراح ذكي** `Ctrl+Shift+G`: بيقرأ سياق ما تكتبه ويقترح جملة أو callout أو قائمة مناسبة. - -**مولّد قوالب** `Ctrl+Shift+T`: اكتب وصف (مثل "محضر اجتماع أسبوعي") والـ AI يولّد قالب Obsidian كامل. - -يدعم Ollama المحلي (مجاني) + OpenAI + أي خدمة متوافقة مع OpenAI (OpenRouter, Groq…). - -### 🖼 التحكم في الصور *(وضع القراءة)* -انقر على أي صورة لتظهر شريط أدوات: تكبير/تصغير، محاذاة، تدوير، caption، Reset، نسخ Markdown، lightbox كامل. - -### ⛶ ملء الشاشة — `Ctrl+Shift+Z` -زر عائم على كل ملف + دخول تلقائي لملء الشاشة بعد فترة خمول قابلة للتحديد. - -### 🌳 شجرة الملفات المحسّنة -أيقونات بأسلوب Apple SF Symbols لكل نوع ملف + صور مصغّرة للصور داخل الشجرة. - -### ⚡ شريط الوصول السريع -شريط أزرار ثابت فوق شجرة الملفات — كل زرار يفتح ملف أو فولدر بضغطة واحدة. - -### 📁 وضع التركيز على فولدر -كليك يمين على أي فولدر ← "ركّز على هذا الفولدر": الشجرة بتعرض محتوياته بس، وكل حاجة تانية بتختفي. شريط تابات للفولدرات الرئيسية فوق الشجرة للتنقل السريع. - ---- - -## التثبيت - -### عبر BRAT *(متاح الآن)* -1. ثبّت إضافة [BRAT](https://github.com/TfTHacker/obsidian42-brat) -2. BRAT → Add Beta Plugin → أدخل `ahmdmusa/obsidian-toolkit` -3. فعّل الإضافة - -### يدوياً -1. حمّل `main.js` و`styles.css` و`manifest.json` من [Releases](https://github.com/ahmdmusa/obsidian-toolkit/releases/latest) -2. انسخهم إلى `/.obsidian/plugins/obsidian-toolkit/` -3. أعد فتح Obsidian → Settings → Community Plugins → فعّل **Obsidian Toolkit** - ---- -1 -2 - -3 - -4 -5 -55 -3 2 -6 -7 - - -### licence - -MIT — by [ Ahmed Mousa - EG26 ](https://github.com/ahmdmusa) -#### thanks