Obsidian Plugin
The MDtoLink plugin for Obsidian lets you publish, update, and unpublish notes without leaving your vault.
Installation
Section titled “Installation”Install from the Obsidian community plugin directory:
- Open Settings > Community plugins
- Click Browse and search for MDtoLink
- 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.
- Go to app.mdtolink.com and create an account (or sign in)
- Generate an API key from your dashboard (Account > API Keys)
- Open the MDtoLink plugin settings in Obsidian and paste your API key
- Click Test to verify the connection
Publishing a note
Section titled “Publishing a note”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"---Updating a published note
Section titled “Updating a published note”Just publish again. The plugin detects the mdtolink-id in frontmatter and updates the existing document. The URL stays the same.
Custom slugs
Section titled “Custom slugs”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.
Unpublishing
Section titled “Unpublishing”Open the command palette and run Unpublish from MDtoLink. The document is removed and the frontmatter is cleared.
Copy link
Section titled “Copy link”Run Copy MDtoLink URL from the command palette to copy the shareable link for an already-published note.
Commands
Section titled “Commands”| Command | Description |
|---|---|
| Publish to MDtoLink | Publish or update the active note |
| Unpublish from MDtoLink | Remove the active note from MDtoLink |
| Copy MDtoLink URL | Copy the shareable link to clipboard |
Settings
Section titled “Settings”| Setting | Default | Description |
|---|---|---|
| API key | — | Your mdtolink_... API key |
| Publish as public | On | Whether new notes are publicly accessible by default. Turn off to publish private documents (Pro+ only). |
Status bar
Section titled “Status bar”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:
| Feature | Free | Pro | Publisher |
|---|---|---|---|
| Published documents | 5 | Unlimited | Unlimited |
Custom handles (/@you/slug) | — | Yes | Yes |
| Private documents | — | Yes | Yes |
| Remove branding | — | Yes | Yes |
| Custom domains | — | — | Yes |
Upgrade from the plugin settings or at app.mdtolink.com/dashboard/plans.