Obsidian plugin
Publish markdown notes to Sitepaste directly from Obsidian. The plugin handles single files and entire folders, with a confirmation step before anything is published.
Setup
- Install the Sitepaste plugin from Obsidian’s community plugins.
- Open Settings > Sitepaste.
- Enter your API key from the Sitepaste dashboard under Settings > API tokens. See the authentication docs for details on creating tokens.
- Optionally set a site ID if you have multiple sites. Leave it empty to use your default site.
Publishing
There are three ways to publish.
Click the upload icon in the ribbon to publish the file you are currently editing. Open the command palette and run “Publish current file” for the same result. Right-click any file or folder in the file explorer and choose “Publish to Sitepaste” or “Publish folder to Sitepaste” from the context menu.
Before anything is sent, the plugin shows a confirmation modal listing every page that will be created or updated. Folder publishes show a progress modal as pages are synced.
After publishing, the plugin writes a sitepaste-slug field into the file’s front matter. The next time you publish the same file, this slug tells the plugin to update the existing page rather than creating a new one.
Settings
| Setting | Default | Description |
|---|---|---|
| API key | Your Sitepaste API token. | |
| Site ID | Optional target site UUID. Leave empty for your default site. | |
| Default content type | docs | Content type for pages that do not specify one in front matter. Options: docs, blog, standalone. |
| Trigger build | On | Triggers a site build after publishing. Turn off to save build quota when making many small changes. |
| Dry run | Off | Validates locally and shows a summary without calling the API. Useful for previewing what would be published. |
Front matter
You can add front matter to any note to control how it appears on your site. All fields are optional.
| Field | Description |
|---|---|
slug | URL slug for the page. Defaults to a slugified version of the filename. |
title | Page title. Defaults to a titleized version of the slug. |
contentType | Override the default content type for this page. Must be docs, blog, standalone, or homepage. |
description | Meta description for the page. |
draft | Set to true to hide the page from the published site. |
tags | A list of tags. |
date or publishedAt | Publish date. |
The plugin also writes these fields after publishing:
| Field | Description |
|---|---|
sitepaste-slug | The slug used on Sitepaste. Tells the plugin to update this page on the next publish. |
sitepaste-published | Timestamp of the last publish. |
Folder publishing
When you publish a folder, every markdown file inside it (including subfolders) is included. The plugin checks for duplicate slugs and validates all pages before sending anything. Homepage pages must be published individually and cannot be part of a folder batch.
Large folders are split into batches automatically. A site build is only triggered after the final batch succeeds.
Errors
If something goes wrong, the plugin shows a notice with a clear message. Common cases include an invalid or missing API key, a Pro plan being required, storage or build quota limits, and rate limiting. Validation errors show which field failed and why.
Learn more
The plugin source is available in the integrations repository. For details on the underlying API, see the pages API docs and the builds API docs.