Make It Rain - Documentation
Seamlessly import your Raindrop.io bookmarks into Obsidian.md
Welcome to Make It Rain! This documentation will help you get the most out of the plugin, whether you’re a first-time user or an advanced contributor.
🚀 Start Here
New to Make It Rain? Begin with these essential guides:
- Installation Guide - Get the plugin up and running
- Quick Start Configuration - Set up your API token in 2 minutes
- Your First Import - Import your first bookmarks
✨ Key Features at a Glance
🎯 Flexible Filtering & Importing
- Bulk Import: Fetch multiple bookmarks with advanced filtering by collections, tags, and content types
- Quick Import: Import individual items by URL or ID
- Selective Sync: Only fetch new items or update existing notes
- Smart Filtering: Combine collections, tags (AND/OR logic), and content types
🗂️ Smart Organization
- Automatic Folder Hierarchy: Replicates your Raindrop collection structure in Obsidian
- Rich Metadata: Comprehensive YAML frontmatter with all important details
- Customizable Filenames: Use template variables to create meaningful note names
- Tag Integration: Automatically append custom Obsidian tags to imported notes
🎨 Powerful Customization
- Template System: Full control over note format with Handlebars-like syntax
- Content-Type Templates: Different formats for articles, images, videos, and more
- Banner Images: Display cover images from your bookmarks
- Flexible Formatting: Customize every aspect of your imported notes
⚙️ Robust & Reliable
- Smart Rate Limiting: Gracefully handles API limits with automatic retries
- Safe by Default: Prevents accidental overwrites of existing notes
- Detailed Logging: Full transparency for troubleshooting
- Stable Builds: Automated CI/CD ensures reliability
📚 Documentation Guide
For Users
Getting Started
- 📥 Installation Guide - Install and get your API token
- ⚙️ Configuration Guide - Set up the plugin to your liking
- 📖 User Guide - Complete user documentation
Using the Plugin
- 🔄 Usage Guide - Learn how to import and organize bookmarks
- 📂 Collections - Working with your Raindrop collections
- 🏷️ Tags - Tag filtering and management
- 📋 Note Structure - Understanding the note format
Customization
- 🎨 Template System - Customize how notes are formatted
- 🖼️ Template Gallery - Pre-built templates and examples
Help & Resources
- 🆘 Troubleshooting - Fix common issues
- ❓ FAQ - Frequently asked questions
- ⚠️ Known Issues - Current limitations and workarounds
For Developers
Contributing
- 👨💻 Developer Guide - Set up your development environment
- 🏗️ Architecture Overview - Understand the codebase
- 📝 Contributing Guide - Contribution workflow and standards
Technical Resources
- 🔌 API Reference - API documentation
- ✅ Testing Guide - Writing and running tests
- 🔨 Build Verification - Verifying builds
🎯 Common Tasks
First Time Setup
Installation → API Configuration → Test Import → Explore Settings
Follow the Getting Started Guide →
Daily Workflow
Add bookmarks in Raindrop.io → Run "Fetch Raindrops" → Organize in Obsidian
Custom Templates
Explore examples → Customize template → Test with small batch → Import full collection
Template customization guide →
Contributing Code
Fork repository → Set up dev environment → Create feature branch → Write tests → Submit PR
🤔 Quick Reference
| I want to… | See… |
|---|---|
| Install the plugin | Installation Guide |
| Set up my API token | Configuration Guide |
| Import all my bookmarks | Usage Guide |
| Customize note format | Template System |
| Filter by collection | Collections Guide |
| Filter by tags | Tags Guide |
| Fix import errors | Troubleshooting |
| Set up development | Developer Guide |
| Write tests | Testing Guide |
| Contribute code | Contributing Guide |
📖 Documentation Structure
docs/
├── index.md ← You are here!
├── user-guide/ ← User documentation
│ ├── README.md
│ ├── installation.md
│ ├── configuration.md
│ ├── usage.md
│ ├── collections.md
│ ├── tags.md
│ ├── note-structure.md
│ ├── template-system.md
│ ├── template-gallery.md
│ ├── troubleshooting.md
│ ├── faq.md
│ └── known-issues.md
├── developer-guide/ ← Developer documentation
│ ├── README.md
│ ├── index.md
│ ├── api-reference.md
│ ├── testing-guide.md
│ └── BUILD_VERIFICATION.md
└── release-notes/ ← Version history
💡 Getting Help
Can’t find what you’re looking for?
- Quick answers: Check the FAQ
- Common issues: Review Troubleshooting
- Known limitations: See Known Issues
- Community: Visit GitHub Discussions
- Report bugs: Open an issue on GitHub
🔗 Resources
- GitHub Repository: frostmute/make-it-rain
- Raindrop.io: raindrop.io
- Obsidian: obsidian.md
- Changelog: View all releases
🎓 Learning Paths
Path 1: Just Getting Started
→ Installation → Configuration → Usage
Path 2: Power User
→ Template System → Template Gallery → Advanced Filtering
Path 3: Contributing Developer
→ Developer Guide → Contributing → Testing
**Ready to get started?** [→ Install Make It Rain](/make-it-rain/user-guide/installation.html)
For updates and news, follow the [Changelog](../CHANGELOG.md)