Repository navigation
Getting started syncing a workspace to Confluence
A step-by-step first run of the LoreMaster VS Code extension. It is a preview; the first feature is syncing a workspace's Markdown into Confluence.
In VS Code: Extensions → search LoreMaster (LoreMaster.loremaster) → Install.
It needs VS Code 1.101 or later. The extension bundles its own engine, so there is
nothing else to install.
Open the folder whose Markdown you want to sync. Each .md file becomes a page; the first
# H1 is its title.
Command Palette (Ctrl/Cmd+Shift+P) → LoreMaster: Add Connection — or the
Accounts menu (bottom-left) → Sign in with Confluence. Then:
- Enter the site URL (any page URL of the site works), e.g.
https://your-site.atlassian.net/wiki(Cloud) orhttps://confluence.example.com(Data Center). The edition is detected for you. - Choose how to sign in:
- Cloud — your Atlassian account email + an API token.
- Data Center — a personal access token.
- The connection is verified and saved. The secret lives in VS Code's secret store, never in your repository.
Command Palette → LoreMaster: Sync (or Sync Current File for just the open file).
The first sync asks where things go — the space, the parent page everything nests
under, and a title prefix (pages are titled <prefix>: <H1>). Your answers are written to
.lore-master.yaml in the workspace, so later syncs do not ask again.
Then LoreMaster shows a plan — what it would create, update, move, or leave unchanged — and waits for you to confirm before writing anything. Confirm, and it creates the pages parents-first, uploads images, renders Mermaid diagrams to images, and links pages to each other by title.
Open the LoreMaster icon in the activity bar and expand Pages. It lists every Markdown file as the tree it is, or will be, on the storage — the same nesting the sync applies — each with an icon:
| Icon | Meaning |
|---|---|
+ new |
Not on the platform yet; the next sync creates it. |
| ✓ synced | The file is the one last synced. |
| ✎ local changes | The file changed since the last sync; the next sync updates the page. |
| ☁↓ remote changes | The page was edited on the platform since the last sync. |
| ⚠ conflict | Both the file and the page changed. |
| 🔗 will adopt | A page with this title exists; the next sync takes it over. |
Without a connection the view knows the local half: new, synced or local changes, read from the files and their annotations. Click Check remote status (the cloud button in the view's title bar) to ask the platform too — it only reads, and adds remote changes, conflicts and pages whose file is gone. The answer is dropped again as soon as a file changes, so the view never shows a platform state it has not just asked for.
-
Titles or file names: the button next to it switches how pages are named — their
content title (first heading) or their file name. The other one is shown beside it, and
the choice is the
loreMaster.pages.labelsetting. - Click a page to open its file; the cloud-upload button on a row syncs just that page.
- A Local node above the storages lists every Markdown file in the repository and which storages sync it; each storage gets its own group.
- The tree follows
roots,excludes,ignoreandskipGitignoredfrom.lore-master.yaml, so what you see is what a sync would read. -
Left out (collapsed, under the pages) lists the Markdown files the sync does not read, each
with the setting that left it out: the
ignorelist, the storage'sexcludes, a.gitignore, or being outside the folders to sync. Click one to open it.lore-master-engine treeprints the same list.
A file is left out if any of these applies, unless a storage's include: takes it back with a
more specific entry:
| Setting | Applies to | |
|---|---|---|
ignore: (top level) |
every storage | gitignore-style patterns, e.g. CLAUDE.md, internal/
|
exclude: / excludes: (on a storage / its content entry) |
that storage | same patterns |
include: (on a storage) |
that storage | takes a file or folder back from an exclusion |
skipGitignored |
the workspace |
true by default: Markdown a .gitignore ignores is not synced |
Change the ignore list from Edit storage → Ignored paths (all storages), or in the file,
and right-click a page or folder in the Pages view for Do not sync…. The Local node
lists every file with where it goes. See Choosing what goes where.
In the Storages view, click the pencil on a storage (or run LoreMaster: Edit storage). Pick a setting, then its new value:
-
Confluence: title prefix, direction (
to-platformortwo-way), Mermaid diagrams (imageorcode), how pages link to each other, what to do when a title already exists, the folders to sync, and paths to leave out. - GitHub Pages: the repository, the branch, the folder inside the branch (so another site can share it), the folders to sync, and paths to leave out.
The value is checked and saved to .lore-master.yaml with your comments kept; a value that is
not allowed is refused with the reason and nothing is written. For anything else, Open
config opens the file.
- A page tree mirroring your files: nesting from
parent:annotations, dotted filenames (readme.architecture.mdunderreadme.md), directoryREADME.mdindexes, then the parent you chose. - Each synced file gains a small
<!-- lore-master … -->annotation recording its page, so a re-run changes only what actually changed — it never makes duplicates.
.lore-master.yaml is created for you; see the schema and options (space, titlePrefix,
mermaidMode, titleCollision, linkMode, content roots) in the project
README.md.
- "not compatible with this version of Visual Studio Code" — update VS Code to 1.101+.
- No connection yet — run LoreMaster: Add Connection first; a sync with no connection just prompts you to add one.
-
A custom engine build — point
loreMaster.engine.pathat a binary if you are developing the engine; otherwise the bundled one is used.
-
LoreMaster documentation
- A documentation agent that follows the LoreMaster structure
- ADR: One Go engine, thin editor shells
- ADR: Vertical feature slices, in Go and TypeScript
- Choosing what goes where
- Command line
- Confluence editions: the facts the design rests on
- Confluence tenant for recorded fixtures
- Generators: pages written from your project's artifacts
- Getting started: syncing a workspace to Confluence
- GitHub Action: the docs site in one step
- Publishing to a GitHub wiki
- The MCP server
- Two-way sync: pull remote edits back, conflict when both sides change
- Using the MCP server
- Watch mode