Initial commit
This commit is contained in:
47
README.md
Normal file
47
README.md
Normal file
@@ -0,0 +1,47 @@
|
||||
# Memos Clipper — Chrome Extension
|
||||
|
||||
Clip any web page or selection as Markdown directly to your [usememos](https://usememos.com) instance. Images are uploaded as attachments. Preview and edit before sending.
|
||||
|
||||
## Features
|
||||
|
||||
- **Full page or selection** — clip the whole article (auto-extracted) or just what you've selected
|
||||
- **Markdown preview** — live rendered preview with syntax highlighting
|
||||
- **Edit before send** — tweak the Markdown in the built-in editor
|
||||
- **Image attachments** — images found on the page are uploaded as resources; toggle per-image
|
||||
- **Visibility control** — Private / Protected / Public per memo
|
||||
- **Source attribution** — automatically prepends a blockquote with the source URL and title
|
||||
|
||||
## Installation
|
||||
|
||||
1. Open Chrome and go to `chrome://extensions/`
|
||||
2. Enable **Developer mode** (top right toggle)
|
||||
3. Click **Load unpacked**
|
||||
4. Select this folder (`memos-extension/`)
|
||||
|
||||
## Configuration
|
||||
|
||||
1. Click the extension icon → **⚙ settings gear** (or right-click → Options)
|
||||
2. Enter your Memos instance URL, e.g. `https://memos.example.com`
|
||||
3. Generate an access token in Memos: **Settings → Account → Access Tokens**
|
||||
4. Paste the token and click **Save Settings**
|
||||
5. Click **Test Connection** to verify
|
||||
|
||||
## Usage
|
||||
|
||||
1. Navigate to any web page
|
||||
2. *(Optional)* Select text you want to clip
|
||||
3. Click the Memos Clipper icon in the toolbar
|
||||
4. The page (or selection) is extracted as Markdown
|
||||
5. Edit if needed, check the **Preview** tab
|
||||
6. Adjust visibility and image settings
|
||||
7. Click **Send to Memos**
|
||||
|
||||
## API compatibility
|
||||
|
||||
Tested against usememos **v0.22+** (uses `/api/v1/memos` and `/api/v1/resources`).
|
||||
|
||||
## Notes
|
||||
|
||||
- Images on cross-origin pages may fail to upload due to CORS restrictions — these will be skipped gracefully
|
||||
- The extension uses Chrome's `scripting` permission to inject the content extractor on demand
|
||||
- No data is ever sent anywhere except your own Memos instance
|
||||
Reference in New Issue
Block a user