mirror of
https://github.com/johnkim05/obsidian-uuugl-plugin.git
synced 2026-07-22 06:42:18 +00:00
95 lines
2.9 KiB
Markdown
95 lines
2.9 KiB
Markdown
# uuu.gl Markdown Uploader for Obsidian
|
|
|
|
Upload your Obsidian notes to [uuu.gl](https://uuu.gl) as beautifully rendered Markdown documents with all images and internal links preserved.
|
|
|
|
## Features
|
|
|
|
✨ **One-Click Upload** - Upload your notes directly from Obsidian
|
|
📸 **Image Preservation** - Automatically uploads and embeds all images
|
|
🔗 **Custom Short URLs** - Create memorable URLs like `uuu.gl/my-note`
|
|
🔒 **Password Protection** - Optionally protect your notes with a password
|
|
💾 **Auto-Save** - Real-time auto-save with version control
|
|
🎨 **Beautiful Rendering** - GitHub Flavored Markdown with syntax highlighting
|
|
|
|
## How It Works
|
|
|
|
1. Write your note in Obsidian
|
|
2. Click the upload icon or use the command palette
|
|
3. Choose a custom shortcode (e.g., `my-note`)
|
|
4. Your note is instantly available at `https://uuu.gl/my-note`
|
|
|
|
## Installation
|
|
|
|
### From Obsidian Community Plugins
|
|
|
|
1. Open Settings → Community Plugins
|
|
2. Search for "uuu.gl"
|
|
3. Click Install
|
|
4. Enable the plugin
|
|
|
|
### Manual Installation
|
|
|
|
1. Download `main.js`, `manifest.json`, and `styles.css` from the [latest release](https://github.com/johnkim05/obsidian-uuugl-plugin/releases)
|
|
2. Create a folder named `uuugl-uploader` in your vault's `.obsidian/plugins/` directory
|
|
3. Move the downloaded files into the folder
|
|
4. Reload Obsidian and enable the plugin in Settings → Community Plugins
|
|
|
|
## Usage
|
|
|
|
### Upload a Note
|
|
|
|
**Method 1: Ribbon Icon**
|
|
- Click the cloud upload icon in the left sidebar
|
|
|
|
**Method 2: Command Palette**
|
|
- Press `Cmd/Ctrl + P`
|
|
- Type "Upload current note to uuu.gl"
|
|
- Press Enter
|
|
|
|
**Method 3: Custom Hotkey**
|
|
- Set a custom hotkey in Settings → Hotkeys
|
|
- Search for "uuu.gl: Upload current note"
|
|
|
|
### Options
|
|
|
|
- **Custom Shortcode**: Create memorable URLs (e.g., `meeting-notes`)
|
|
- **Random Shortcode**: Generate a random 8-character code
|
|
- **Password Protection**: Add a password to protect your note
|
|
|
|
### Status Bar
|
|
|
|
After uploading, the status bar shows your note's URL. Click to copy!
|
|
|
|
```
|
|
🔗 my-note ← Click to copy full URL
|
|
```
|
|
|
|
## Settings
|
|
|
|
- **Default Shortcode Prefix**: Customize the prefix for auto-generated shortcodes (default: `obsidian`)
|
|
- **Google Sign In**: Sign in to track your uploads and manage them at [uuu.gl/my-memos](https://uuu.gl/my-memos)
|
|
|
|
## Privacy
|
|
|
|
- **Anonymous Uploads**: You can upload without signing in
|
|
- **User Data**: We only store your email if you choose to sign in with Google
|
|
- **Content**: Your notes are stored securely on Firebase
|
|
- **Deletion**: You can delete your uploads anytime from the uuu.gl website
|
|
|
|
## Support
|
|
|
|
- **Website**: [uuu.gl](https://uuu.gl)
|
|
- **Issues**: [GitHub Issues](https://github.com/johnkim05/obsidian-uuugl-plugin/issues)
|
|
- **Email**: john050151@gmail.com
|
|
|
|
## License
|
|
|
|
MIT License - feel free to use and modify!
|
|
|
|
## Credits
|
|
|
|
Developed by [uuu.gl](https://uuu.gl)
|
|
|
|
---
|
|
|
|
**Note**: This plugin requires an internet connection to upload notes to uuu.gl servers.
|