Skip to content

Obsidian Plugin

The MDtoLink plugin for Obsidian lets you publish, update, and unpublish notes without leaving your vault.

Install from the Obsidian community plugin directory:

  1. Open Settings > Community plugins
  2. Click Browse and search for MDtoLink
  3. Click Install, then Enable

Or install manually from the GitHub releases: download main.js, manifest.json, and styles.css into .obsidian/plugins/mdtolink/ in your vault.

  1. Go to app.mdtolink.com and create an account (or sign in)
  2. Generate an API key from your dashboard (Account > API Keys)
  3. Open the MDtoLink plugin settings in Obsidian and paste your API key
  4. Click Test to verify the connection

Open any markdown note and either:

  • Click the share icon in the ribbon (left sidebar)
  • Open the command palette (Ctrl/Cmd+P) and run Publish to MDtoLink

The note is published and the shareable URL is copied to your clipboard. Frontmatter is added to track the published document:

---
mdtolink-id: "doc_abc123"
mdtolink-slug: "my-note"
mdtolink-url: "https://app.mdtolink.com/@username/my-note"
---

Just publish again. The plugin detects the mdtolink-id in frontmatter and updates the existing document. The URL stays the same.

The plugin automatically derives a slug from your note’s filename. A note called Meeting Notes.md gets the URL /@username/meeting-notes. This requires a Pro or Publisher plan — free users get a random /d/ URL.

Open the command palette and run Unpublish from MDtoLink. The document is removed and the frontmatter is cleared.

Run Copy MDtoLink URL from the command palette to copy the shareable link for an already-published note.

CommandDescription
Publish to MDtoLinkPublish or update the active note
Unpublish from MDtoLinkRemove the active note from MDtoLink
Copy MDtoLink URLCopy the shareable link to clipboard
SettingDefaultDescription
API keyYour mdtolink_... API key
Publish as publicOnWhether new notes are publicly accessible by default. Turn off to publish private documents (Pro+ only).

The status bar shows the publish state of the active note:

  • MDtoLink: Published — this note has been published
  • MDtoLink: Not published — this note has not been published yet

Your plan determines what features are available from the plugin:

FeatureFreeProPublisher
Published documents5UnlimitedUnlimited
Custom handles (/@you/slug)YesYes
Private documentsYesYes
Remove brandingYesYes
Custom domainsYes

Upgrade from the plugin settings or at app.mdtolink.com/dashboard/plans.