Publish and sync from VS Code

The Markdrop Sync extension publishes the file you're editing in VS Code and keeps it in step with its link. Save the file and the link updates; edit it on markdrop.in and the change comes back into your file.

Install Markdrop Sync from the Visual Studio Marketplace, or search for "Markdrop Sync" in the Extensions view. From a terminal:

code --install-extension HimanshuKukreja.markdrop

It needs VS Code 1.85 or later.

1. 1

   Start the sign-in

   #Copy sectionAsk about this

   Open the Command Palette (⌘⇧P on macOS, Ctrl+Shift+P elsewhere) and run Markdrop: Sign in.

2. 2

   Approve in your browser

   #Copy sectionAsk about this

   Markdrop opens a Connect VS Code page that shows the account the extension will publish as. Choose Authorize VS Code.

3. 3

   Return to VS Code

   #Copy sectionAsk about this

   Your browser hands you back to VS Code, which shows "Signed in to Markdrop as …".

Signing in creates an API token named "VS Code" on your account, and the extension keeps it in VS Code's Secret Storage. You can see and revoke it on markdrop.in/settings/tokens.

If the browser hand-off doesn't come back to VS Code (for example in a remote or web-based VS Code), create a token on that page and run Markdrop: Sign in with API token to paste it.

Open the file and run Markdrop: Publish / link current file. You can also choose Publish to Markdrop in the status bar, or the publish button in the editor title bar of a Markdown file.

When it's done, VS Code shows the link with Open in browser and Copy link.

• The address is based on the file name. If that address is taken, Markdrop picks a free one close to it.
• The title is the file's first # Heading. For HTML it is the <title>, then the first <h1>. Otherwise it is the file name.
• Who can open it. Anyone with the link. Change that on markdrop.in: see Who can open a link.

The document belongs to your account. Only you can sync it from VS Code.

Use the .html extension for web pages: a .htm file is published as a Markdown document.

PDFs, Word documents, spreadsheets and zipped sites can't be edited as text, so they don't sync from VS Code. Upload them at markdrop.in/upload or with markdrop upload.

From VS Code to Markdrop. When you save a linked file, the extension sends it a moment later (0.8 seconds, so quick saves are sent once). Nothing is sent when the content hasn't changed. Line endings and trailing blank lines don't count as changes.

From Markdrop to VS Code. While VS Code is the focused window, the extension checks the file in the active editor for changes on markdrop.in every 10 seconds, and again when you switch to that file or back to VS Code. When the web version is newer:

• If you haven't changed the file since it last synced, the extension writes the web version into it.
• If you have, both sides changed. The extension opens a comparison and asks you what to keep. See Resolve sync conflicts.

Files in other tabs, or in a VS Code window that isn't focused, are checked when you come back to them.

Sync now. Markdrop: Sync now (push) sends your saved changes and then checks for web changes straight away.

The tooltip on a linked file shows its address and revision.

Run Markdrop: Unlink current file. The file stops syncing; the document on markdrop.in stays as it is. Publish again to make a new link.

If the document is deleted on markdrop.in, the extension unlinks the file the next time it checks and tells you.

Links are stored in .markdrop.json at the root of the workspace folder. It maps each file's path to its document id, address and last synced revision. Commit it to share the links with your team, or add it to .gitignore.

A file opened outside any workspace folder keeps its link in VS Code's own storage on that computer instead.

Sync follows the document's id, not its address, so renaming its address on markdrop.in doesn't break the link.

• Resolve sync conflicts
• Extension settings and commands
• API tokens