README file from
Github🌈 Colorful Folders for Obsidian
Transform your Obsidian file explorer from a dull list into a vibrant, organized, and high-performance visual dashboard.
Colorful Folders automatically applies premium color palettes, smart icons, and structural intelligence to your vault. Whether you prefer a strictly organized, monochromatic workspace or a neon-glowing cyberpunk aesthetic, this plugin makes navigation intuitive and your workspace absolutely beautiful.
Updates for Colorful Folders
🚀 5.0.0 - Architectural Overhaul & New Features
🌲 1. Perfect Folder Scope Hierarchy (New Mode under Hierarchy Mode)
- Matching Colors by Tree Depth: Notes and subfolders at the exact same depth level receive matching colors for a clean, balanced layout:
- Level 1 (Root folders & root notes) = Color A
- Level 2 (Subfolders & notes inside root folders) = Color B
- Level 3 (Deeper subfolders) = Color C
- No Level Mismatches: Notes align visually with their exact folder depth in your sidebar.
⚡ 2. Instant Auto-Icons (Offline & Free)
- No API Keys Needed: Automatically pick perfect icons for your notes and folders in seconds—completely offline, private, and 100% free!
- Blazing Fast: Classifies hundreds of notes in less than a second.
- Smart Matching: Connect your favorite local AI models (via Ollama) for intelligent icon selection.
- Live Progress Bar: Watch real-time scanning progress as your vault gets automatically styled.
🤖 3. Smart AI Icon Assistant
- Context-Aware Styling: Automatically style your vault based on the actual topics and content of your notes.
- Automatic Icon Fallbacks: If a suggested icon isn't installed, the plugin automatically finds the closest matching alternative from Lucide, Simple Icons, or FontAwesome.
🚀 4. Butter-Smooth Performance & Zero Conflicts
- Rebuilt Styling Engine: Redesigned how colors are rendered under the hood for faster updates and zero layout glitches.
- Zero Lag in Large Vaults: Ultra-optimized calculations keep scrolling completely smooth, even in vaults with 10,000+ files.
✨ Core Features
🎨 Vivid Color & Visual Hierarchy
- Color-Coding Hierarchy: Automatically assigns beautiful, distinct colors to top-level and nested folders.
- Visual Wayfinding: Glowing connector lines create a clear "breadcrumb trail" to your currently active file.
- Smart Rainbow Logic & Text: Cycle files through your palette, enable custom rainbow text gradients on individual items, or use the Adaptive Heatmap to sync colors.
- Curated Palettes: Premium built-in palettes (including Tailwind UI, Tailwind UI Dark, Cyberpunk, Nord, and Pastel).
- Minimalist Modes: Force subfolders to inherit parent colors, or use Outline Only Mode to remove background tints while keeping bright connecting lines.
🤖 Smart Iconography & Custom Packs
- Auto-Icon Engine: Automatically injects high-fidelity icons based on item names (e.g., Journal -> 📅, Finance -> 💰).
- Local Icon Pack Support: Drop any custom SVG icon pack into
.obsidian/iconsfor instant, parallel-scanned icon loading. - Custom Open/Closed Icons: Define custom global defaults or per-item overrides for open and closed folder states.
- Built-in Offline Libraries: Includes Material, FontAwesome, Lucide, Tabler, Simple Icons, and Vibrant packs for instant offline rendering.
- Universal 18px Sizing: All icons are standardized to a professional 18px baseline with perfect vertical centering.
📁 Advanced Customization & Typography
- Right-Click WYSIWYG Menu: Select "Set Custom File Style" on any item to easily override its color, icon, border radius, and text formatting.
- Custom Border Radius: Adjust border-radius per folder or file using a smooth range slider in the style modal.
- Advanced Typography: Make key projects pop with bold, italic, custom text colors, and rainbow gradients.
- Smart Inheritance: Force a specific style down an entire folder tree with a single click.
📐 Organization & Appearance Controls
- Toggle Collapse Indicators: Easily show or hide folder collapse arrows in the file explorer via settings.
- Section Dividers: Group files with vertical visual dividers supporting glassmorphic popovers and custom line styles.
- Dynamic Item Counters: Display recursive statistics showing total folder and file counts.
- Exclusion Lists: Keep utility directories (like
attachmentsortemplates) standard and unaffected.
🎨 Synchronization & Ecosystem
- Tag Color Sync: Automatically color tags matching styled folder names (e.g., styling "Work" styles
#Work). - Custom Tag Rules: Manually map specific tags to any styled folder path (e.g.,
#todo = /Projects/Active). - Graph View Sync: Folder colors sync directly into Obsidian's built-in Graph View as color groups.
- Notebook Navigator Integration: Seamless style synchronization with Notebook Navigator.
🕵️ Stealth & Privacy Engine
- Visual Privacy: Hide any file or folder from the sidebar instantly via context menu.
- Ghost Mode: Toggle semi-transparent viewing of hidden items with a sleek blur effect.
- Password Protection: Secure privacy settings with a custom modal.
🛡️ Stability & Performance Engine
- Zero-DOM Engine: High-performance
adoptedStyleSheetsengine with zero GPU lag, even in 10,000+ note vaults. - Cross-Platform: Flawless performance across Windows, macOS, Linux, Android, and iOS.
- Strict Network Privacy: 100% private offline styling engine with zero user data transmission.
🛠️ Installation
Via Obsidian Community Plugins (Official & Recommended)
- Open Obsidian and navigate to Settings > Community plugins.
- Click Browse next to Community plugins.
- Search for Colorful Folders.
- Click Install, then click Enable.
Via BRAT (For Beta Releases)
Want to test the absolute latest features before they hit the store?
- Install the BRAT plugin from the Obsidian Community gallery.
- Go to Settings > BRAT > Beta Plugin List.
- Click Add Beta plugin.
- Paste the repository URL:
https://github.com/RohitNahar-Offical/colorful-folders-obsidian - Click Add Plugin.
- Enable Colorful Folders in your Community plugins tab.
💡 Pro Tip
Access all styling configurations by navigating to Settings > Colorful Folders. Look for the large "💡 Pro Tip" banner at the top of the settings page to discover hidden tricks, including how to set up custom overriding colors!
👨💻 Developer Documentation
Looking to understand the internal architecture, contribute features, or debug the styling engine? Check out our comprehensive technical guides:
- Master Documentation Index: The entry point for all technical documentation and subsystem guides.
- Internal Engine Architecture: Deep dive into the Zero-DOM rendering pipeline and logic flow.
- API Reference: Detailed class and method documentation.
- Customization Guide: Advanced CSS snippets and styling overrides.
Developed with ❤️ by ROHIT-NAHAR