Skip to content

VS Code Extension

Publish and manage elephant.md documents directly from your editor.

Get Started

  1. 1
    Install

    Install from VS Code Marketplace

    Or search "elephant.md" in the extensions panel (Cmd+Shift+X / Ctrl+Shift+X).

  2. 2
    Log in

    Run Elephant: Login from the command palette (Cmd+Shift+P / Ctrl+Shift+P).

  3. 3
    Publish

    Open a markdown file and run Elephant: Publish. Fill in title, slug, category, and visibility in the metadata form.

Commands

  • Elephant: Publish — Create a new document with full metadata form
  • Elephant: Push — Push the active file as an update to an existing document
  • Elephant: Pull — Download a document into your workspace
  • Elephant: Create Burn Link — Create a self-destructing burn link from the active file
  • Elephant: Create Collection — Create a new collection to organize documents
  • Elephant: Add to Collection — Add a tracked document to a collection
  • Elephant: Toggle Bookmark — Bookmark or unbookmark a tracked document
  • Elephant: Login — Authenticate with elephant.md

Document Tracking

When you publish or pull a document, the extension creates an .elephant.json file in your workspace root. This file maps local files to their remote counterparts so that Push knows which document to update.

{
  "README.md": {
    "id": "abc123",
    "slug": "readme",
    "username": "you"
  }
}

Editor Compatibility

The extension works in any editor that supports VS Code extensions, including Cursor and Windsurf.

Status Bar

When editing a tracked markdown file, the status bar shows the elephant.md document status. Click it to quickly push an update.