Skip to main content

Bidirectional sync between a Slidev markdown deck and Google Slides as native, editable objects

Project description

slidesync

Bidirectional sync between a Slidev markdown deck and Google Slides — as native, editable objects (title/body/bullets/tables/positioned images, brand-styled text boxes), not pasted screenshots.

Version: 0.4.1

uvx slidesync --help            # run without installing
pip install slidesync           # or install the CLI + library

Why

Exporting a deck to images gives you something you can't edit; pasting markdown by hand gives you something you can't version. slidesync keeps a .slidev.md file as the source of truth and renders it into real Slides objects, so the result stays fully editable in Google Slides — and pull reconstructs the markdown back from those objects, so the loop is reversible.

  • push — markdown → Slides (idempotent upsert, never a blind append).
  • pull — Slides → markdown (handles multi-text-box and externally-authored decks, bullet nesting, tables, images, and speaker notes).
  • roundtrip — push a sample to a scratch deck, pull it back, assert the two are semantically identical, delete the scratch deck.

Auth (no setup)

Auth is borrowed from the gog CLI — no separate OAuth client. slidesync reads the client id/secret from ~/Library/Application Support/gogcli/credentials.json and the refresh token via gog auth tokens export, then mints a short-lived access token. The stored token already carries the slides + drive scopes; the Slides API must be enabled on the gog Cloud project. Override the account with --account or $SLIDESYNC_ACCOUNT. (Currently macOS-only — it reads gog's macOS Application Support path.)

Commands

Command Purpose
slidesync push <file.slidev.md> [--deck ID] [--new "Title"] [--anchor SLIDE] [--prune] [--force] markdown → Slides (rejected if it would discard live edits; --force overrides)
slidesync pull <deckId> --out <file.md> [--all] Slides → markdown (--all includes non-managed slides)
slidesync roundtrip [--keep] self-test: push a sample, pull, assert identical
slidesync layouts <deckId> list a deck's theme layouts + placeholders
slidesync make-templates <deckId> inject branded {{token}} template slides
slidesync comments <deckId> list comment threads as JSON (page anchor, author, content, replies)
slidesync sync <file.slidev.md> [--deck ID] reconcile with the live deck: pull comments + live edits into the markdown, push local changes; conflicts stop it (exit 1)

push resolves the target deck from (in order) --deck, --new, or a top-level deck: frontmatter key. Relative image paths resolve against the markdown file's directory.

slidesync push deck.slidev.md            # targets `deck:` frontmatter
slidesync push deck.slidev.md --new "Talk"
slidesync pull <id> --out deck.slidev.md
slidesync roundtrip

Idempotent sync (upsert)

Each managed slide is created with objectId = s2g_<keyHash>_<contentHash>. keyHash = per-slide id: frontmatter, else title slug, else index (survives edits/reorders); contentHash is over a canonical render, so push → pull → push is a no-op. Diff per run: identical hash → skip; same key, new content → replace; new key → create. Removed slides are kept unless --prune. Only s2g_ slides are ever touched — hand-authored slides are invisible to the sync. A hidden <!-- s2g {...} --> marker in speaker notes carries the human id, image path, template vars — and, for template slides, the authored body markdown (base64) — so pull recovers the source verbatim.

Sync & drift

push is guarded like a non-fast-forward git push: if a slide it would replace (or prune) was edited in Google Slides since the last push — and the local markdown doesn't already carry that edit — the push is rejected with no changes made (--force overwrites). Live edits on slides the push wouldn't touch are left alone.

sync reconciles the two sides, applying whatever is safe. The marker's last-pushed source is a true per-slide merge base, so each slide classifies three-way without timestamps (the APIs expose no per-slide edit times — only file-level modifiedTime; the marker's at stamp records our last push):

status meaning sync does
clean / converged nothing changed, or both sides made the same change nothing
local-edit markdown changed, deck untouched pushes it
live-drift slide edited in Google Slides writes the live content back into the markdown (reconstructed from its styled boxes, formatting runs included), then pushes
conflict both changed since last push prints both diffs vs the base for a human/LLM to resolve; skips the push; exits 1

Unresolved comment threads are appended to their slide as <!-- @Author: text --> blocks (replies as extra @Author: lines), and threads orphaned by a re-render are re-anchored to their slide via the objectId's key-hash. Captured text round-trips from then on. Write-back caveat: a slide edited live is rewritten canonically, so its authored comments collapse into one trailing block (untouched slides keep comments in place).

Markdown dialect

Top-level frontmatter: theme:, deck:. Slides separated by ---; each slide may have its own frontmatter (id:, template:, layout:).

  • # h1 = headline, ## h2 above an # h1 = kicker; a lone ## is the title.
  • Bullets -/*; ordered 1. (nest with 2-space indent). Inline **bold** / *italic* / `code` / [link](url). GFM tables. ![alt](path) images (uploaded to Drive; alt becomes the accessibility description, round-tripped on pull). Blank lines preserved as spacing. <!-- notes --> become speaker notes — and round-trip as comments, in place: template slides carry their authored source in the marker, so pull re-emits each comment where it was written instead of one merged trailing blob. Speaker notes edited live in Slides come back as one extra trailing comment.
  • Internal links: [text](#slide-id) becomes a native Slides link to the slide whose id: (or title slug) is slide-id.

Built-in brand kit (IBM Plex; red #C0392B kicker)

Select per slide via template: — native styled boxes, no in-deck templates: dark/title, appendix, question/label, topic, content, graph/full (single full-bleed image), prompt/code (verbatim monospace). Title cards (dark/title/appendix) render body lines as a small dimmed byline beneath the headline (e.g. Project · Presenter) — they still have no linkable body region. Slides with no template: fall back to a generative path (section / title+body / table / image) that also brands the background + IBM Plex.

Custom slides (diagrams) — pull-authoritative

Give a slide a fenced ```gslides block holding literal Slides API requests (use __PAGE__ for the slide page id). Sync is pull-authoritative / push-if-missing: the Slides copy is the source of truth — push only creates the slide when missing, pull captures the live drawing back into the block.

Development

uv sync
uv run pytest -q          # offline tests (no network/auth)

Releases publish to PyPI via Trusted Publishing (OIDC) on a v*.*.* tag — see .github/workflows/release.yml. Bump with uvx bumpver update --patch.

Caveats

  • Slidev-only constructs (<v-clicks>, <div grid>, CSS) are flattened/stripped — this is a content mapper, not a CSS renderer.
  • On pull, the slide model holds a single image, so a slide with multiple images keeps the first; image contentUrls from foreign decks are ephemeral.
  • Verbatim-source markers are seeded at push time, so comment preservation applies from the first push with v0.2+ (older slides re-render once: the content hash is now over the authored source). Generative-path slides (no template:) still merge comments into a single trailing comment on pull, since their live Slides edits — not the marker — are the source of truth.

License

MIT © Daniel Hails

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

slidesync-0.4.1.tar.gz (43.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

slidesync-0.4.1-py3-none-any.whl (34.1 kB view details)

Uploaded Python 3

File details

Details for the file slidesync-0.4.1.tar.gz.

File metadata

  • Download URL: slidesync-0.4.1.tar.gz
  • Upload date:
  • Size: 43.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for slidesync-0.4.1.tar.gz
Algorithm Hash digest
SHA256 c52da830ef4f288bba9cc7fe45e70bc407739983e69d5010e9009c8d064eb70f
MD5 7550ac7700dd8b4f3b51bf99a5c3ab9a
BLAKE2b-256 92336076e35d7100ecde46822a7f0e13c157f74c31b157651fa58c0d61388e08

See more details on using hashes here.

Provenance

The following attestation bundles were made for slidesync-0.4.1.tar.gz:

Publisher: release.yml on DJRHails/slidesync

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file slidesync-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: slidesync-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 34.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for slidesync-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1c9257bc733b12b649e2b443cb37c67e51e71787f5c38ddcd5f94b2c10a3faa4
MD5 875844710228ff49be7d59e0542a122d
BLAKE2b-256 66b88d581c1df5d113bca031bcd121e985eed82ca5fb4ec6526192ee988deed8

See more details on using hashes here.

Provenance

The following attestation bundles were made for slidesync-0.4.1-py3-none-any.whl:

Publisher: release.yml on DJRHails/slidesync

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page