README file from
GithubConfluence Weaver
Sync Confluence pages into your Obsidian Vault as Markdown files.
Works with both Confluence Cloud (Basic auth) and Confluence Data Center / Server (Bearer token).
한국어 README: README.ko.md
Features
- CQL Profiles — define multiple Confluence Query Language queries, each targeting a different folder in your Vault
- Fetch by URL — paste any Confluence page URL to import it instantly, with optional child page collection
- Incremental sync — only pages whose version has changed are written; unchanged pages are skipped
- Storage Format → Markdown — converts headings, paragraphs, tables, code blocks, task lists, info panels, and more
- Image download — saves attached images to
_attachments/{pageId}/and embeds them locally - Frontmatter — every page gets
confluence_id,confluence_url,title,space,author,created,updated,version, andlabels - User note protection — content you write below the section marker is preserved across syncs
- Wiki-links — Confluence internal page links can be converted to Obsidian
[[wiki-link]]format (optional) - Folder hierarchy — ancestor pages can be mirrored as nested folders
- Custom field mappings — map any dot-path in the Confluence page JSON to a custom frontmatter key
- Jira Weaver bridge — replace Confluence URLs in Jira Weaver pages with
[[wiki-link]]s automatically - Sync log panel — per-profile created / updated / skipped / error counters
- Auto sync — run on startup and/or on a configurable interval (1–1440 minutes)
- 4 languages — English, 한국어, 日本語, 简体中文
Installation
Search for Confluence Weaver in Settings → Community plugins → Browse.
Setup
- Open Settings → Confluence Weaver
- Enter your Confluence domain (e.g.
https://acme.atlassian.net/wiki) - Choose Auth mode:
- Basic auth (Cloud) — enter your email and an API token
- Bearer token (DC/Server) — enter a Personal Access Token
- Click Test connection — a notice confirms success
- Add one or more CQL Profiles with a query, target folder, and page limit
- Open the command palette and run Sync Pages
CQL examples
space = "DEV" AND ancestor = "Architecture" ORDER BY lastmodified DESC
space = "TEAM" AND label = "weekly-report"
type = "page" AND creator = currentUser() AND lastModified >= startOfMonth()
Fetch by URL
Run Fetch Page by URL from the command palette and paste a Confluence page URL to import it immediately — no CQL profile needed.
Supported URL formats:
https://acme.atlassian.net/wiki/spaces/DEV/pages/123456/Page-Title
https://acme.atlassian.net/wiki/spaces/DEV/pages/123456
https://confluence.internal/pages/viewpage.action?pageId=123456
https://confluence.internal/display/DEV/Page+Title
| Option | Description |
|---|---|
| Include child pages | Also fetch direct children of the page |
| Include all descendants | Recursively collect the entire subtree |
| Max pages | Safety cap for recursive fetches (default 100) |
Image download
Enable Settings → Sync Settings → Download images to automatically save attached images to your Vault during sync.
Confluence/
123456_architecture-overview.md ← ![[Confluence/_attachments/123456/diagram.png]]
_attachments/
123456/
diagram.png
flow-chart.svg
Images are available offline and render directly in Obsidian without any Confluence connection.
Section marker
Each synced file ends with:
[confluence-weaver section end]
Text you write after this line is preserved on every re-sync. Write personal notes, backlinks, or tags there.
Custom field mappings
In Settings → Advanced → Custom field mappings, enter one mapping per line:
space.key → project
version.number → revision
history.createdBy.displayName → confluence_author
Jira Weaver integration
If you also use Jira Weaver, run the command Link Confluence Pages in Jira Notes after syncing. It scans all Jira Weaver files and replaces bare Confluence URLs with [[wiki-link]]s pointing to the synced Confluence pages.
Frontmatter reference
---
confluence_id: "123456"
confluence_url: "https://acme.atlassian.net/wiki/spaces/DEV/pages/123456"
title: "Architecture Overview"
space: "DEV"
space_name: "Development"
author: "Alice"
created: "2025-01-15"
updated: "2025-04-01"
version: 3
labels:
- architecture
- backend
parent: "[[123400_engineering-hub]]"
---
Commands
| Command | Description |
|---|---|
| Sync Pages | Incremental sync for all enabled profiles |
| Force Sync Pages (Overwrite All) | Re-download and overwrite every page |
| Fetch Page by URL | Import a page (and optionally its children) by URL |
| Open Sync Log | Open the sync statistics panel |
| Link Confluence Pages in Jira Notes | Replace Confluence URLs with wiki-links in Jira Weaver files |
License
MIT — GS-AX