Confluence Link Preview
pendingby dpanda
Convert Confluence urls to nicer badges and adds a preview pane for Confluence pages.
Confluence Preview
An Obsidian plugin that brings your Confluence pages into your notes. Paste any Confluence link and it transforms into a clean badge showing the page title — click to open in your browser, or Ctrl-click to read the full page right inside Obsidian.
Features
- Inline badges — Confluence links are replaced with a compact badge showing the Confluence logo, the page title, and optionally the space name. Works in both Reading view and Live Preview (editor).
- Preview pane — Read the full Confluence page without leaving Obsidian. Images are fetched with your credentials and displayed inline.
- Dark mode — The preview pane adapts to Obsidian's light or dark theme automatically.
- Image zoom — Click any image in the preview to enlarge it; press Escape or click again to close.
- Space overview support — Links to a space overview page (e.g.
/wiki/spaces/ENG/overview) are supported in addition to regular page links. - Multiple instances — Configure as many Confluence sites as you need (Cloud, Server, Data Center).
- Configurable link behaviour — Choose whether links inside the preview pane open in your default browser or navigate within the pane itself.
Setup
1. Add a Confluence instance
Go to Settings → Confluence Preview and click + Add Instance.
| Field | What to enter |
|---|---|
| Name | A label for your own reference (e.g. "Work Confluence") |
| Base URL | The root URL of your Confluence site — see examples below |
| Auth type | API token for Cloud; Personal Access Token for Server/DC |
| Username / Email | Your Atlassian account email (Cloud only) |
| Token | Your API token or PAT |
Base URL examples:
| Deployment | Example base URL |
|---|---|
| Confluence Cloud | https://yourcompany.atlassian.net/wiki |
| Confluence Server | https://confluence.yourcompany.com |
| Server with context path | https://intranet.yourcompany.com/confluence |
Click Test connection to verify your credentials before saving.
2. Getting a Confluence Cloud API token
- Go to https://id.atlassian.com/manage-profile/security/api-tokens
- Click Create API token, give it a label, and copy the token.
- Paste it into the Token field and enter your Atlassian account email as the Username.
3. Getting a Confluence Server / Data Center PAT
- Log into your Confluence instance and go to Profile → Settings → Personal Access Tokens.
- Create a token with read permissions.
- Set Auth type to Personal Access Token and paste the token. Leave Username empty.
Usage
Inline badges
Paste a Confluence URL on its own line (or anywhere in a note). Once the plugin fetches the page title it replaces the raw URL with a badge:
https://yourcompany.atlassian.net/wiki/spaces/ENG/pages/123456/My+Page
becomes:
[Confluence logo] My Page · Engineering
- Click the badge — opens the page in your default browser
- Ctrl-click (or Cmd-click on macOS) — opens the page in the Confluence Preview pane inside Obsidian
Badges update automatically as you type. If the cursor is placed inside a URL, the raw link is shown so you can still edit it.
Preview pane
The preview pane opens as a side panel. Use the toolbar buttons to:
- ⟳ — Refresh the current page
- ↗ — Open the current page in your default browser
If you have Open links in → Preview pane enabled in settings, clicking links inside the preview will load the linked Confluence page directly in the pane. Non-Confluence links (e.g. external websites) always open in the browser regardless of this setting.
Settings
| Setting | Description |
|---|---|
| Confluence instances | Add, edit, or remove Confluence sites |
| Cache duration (minutes) | How long page titles are cached before being re-fetched. Set to 0 to always fetch fresh data. Default: 5 |
| Show space name in badge | Display the space name next to the page title in badges (e.g. · Engineering). Default: on |
| Open links in | Where links clicked inside the preview pane go: Default browser or Preview pane. Default: Default browser |
Supported URL formats
The plugin recognises the following Confluence URL patterns:
| Pattern | Example |
|---|---|
| Cloud pages (by ID) | /wiki/spaces/ENG/pages/123456 |
| Cloud pages (with title slug) | /wiki/spaces/ENG/pages/123456/Page+Title |
| Cloud space overview | /wiki/spaces/ENG or /wiki/spaces/ENG/overview |
| Legacy display URLs | /wiki/display/ENG/Page+Title |
| Server viewpage | /pages/viewpage.action?pageId=123456 |
| Server display URLs | /display/ENG/Page+Title |
Troubleshooting
Badges stay in "Loading…" state
- Check your base URL and credentials in Settings. Use the Test connection button.
- Make sure the base URL does not have a trailing slash and matches the hostname of your Confluence links exactly.
Images don't appear in the preview
- Images require valid credentials. Confirm your API token or PAT has not expired.
- Confluence Cloud serves images from a CDN; the plugin fetches them via the REST API attachment endpoint automatically.
"Could not load the Confluence page" error
- Your account may not have permission to view that page.
- For space overview links, ensure your account can access the space's homepage.
Preview pane is blank after restarting Obsidian
- The pane restores automatically. If it appears blank, click any badge with Ctrl-click to reload it.
License
For plugin developers
Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.