Installing Journalit
You'll need Obsidian with community plugins enabled. If you're new to Obsidian, don't worry we'll guide you through everything.
What you need first
- Obsidian installed and running
- Community plugins turned on (we'll show you how)
- Internet connection for the initial setup
Install via BRAT (recommended)
BRAT handles beta plugins like Journalit. It's the fastest way to get up and running.
First, get BRAT:
- In Obsidian, open Settings (the gear icon)
- Go to Community Plugins → Browse
- Search for "BRAT" and install the one by "TfTHacker"
- Enable BRAT in your plugins list
Then, add Journalit:
- Go to Settings → BRAT
- Click "Add Beta Plugin"
- Paste this:
Cursivez/journalit - Choose "Latest version"
- Click "Add Plugin"
Finally, turn it on:
- Back to Settings → Community Plugins
- Find "Journalit" and toggle it on
- You'll see the Journalit icons appear in your ribbon sidebar
That's it. Takes about 2 minutes total.
Method 2: Manual Installation
For advanced users who prefer manual installation:
Step 1: Download Release Files
Download the latest release files from our repository:
main.jsmain.cssmanifest.json
Step 2: Install Files
- Navigate to your vault's
.obsidian/plugins/directory - Create a new folder called
journalit - Place the downloaded files in this folder:
.obsidian/plugins/journalit/ ├── main.js ├── main.css └── manifest.json
Step 3: Enable Plugin
- Restart Obsidian
- Go to Settings → Community Plugins
- Enable the "Journalit" plugin
Post-Installation Setup
Recommended Obsidian Settings
For the best experience with Journalit, configure these Obsidian settings:
- Settings → Editor → Display
- Set "Properties in document" to Hidden
- This prevents trade metadata from cluttering your notes
- You can still edit all of these via Journalit's UI
- Settings → Files & Links
- Enable "Automatically update internal links"
- This ensures trade note links stay valid
Initial Configuration
- After enabling the plugin, you'll see the Journalit icons in your ribbon
- The onboarding wizard will open immediately upon installation
- Follow the guided setup to configure your first trading account
Make sure it worked
You'll know Journalit installed correctly when:
- The Journalit icons appears in your left sidebar ribbon
- Settings → Journalit opens the plugin settings
- The onboarding wizard opens
Don't see the icons? Check that the plugin is enabled in Settings → Community Plugins.
Can't find the settings? Restart Obsidian and try again.
Troubleshooting Installation
BRAT Plugin Not Found
- Ensure Community Plugins are enabled
- Try refreshing the plugin browser
- Manually search for "BRAT" or "TfTHacker"
Repository Not Found Error
- Double-check the repository URL:
Cursivez/journalit - Ensure you have an active internet connection
- Try again in a few minutes (temporary GitHub API issues)
Plugin Won't Enable
- Restart Obsidian completely
- Check that all three files (main.js, main.css, manifest.json) are present
- Verify you have the latest version of Obsidian
Missing Dependencies
- Update to the latest version of Obsidian (minimum version: 0.15.0)
- Clear Obsidian's cache by restarting the application
Getting Help
If you encounter issues during installation:
- Discord: Join our Discord server for real-time help
- Email: Contact [email protected]
- GitHub: Report installation issues
Next Steps
Once installed, continue with:
- Quick Start Guide - Get your first trade logged in 5 minutes
- Authentication Setup - Connect to Journalit services
- Dashboard Overview - Explore the analytics interface
