Prerequisites
- The Publish core plugin is enabled.
- A Publish site is created. See Set up Obsidian Publish.
Publish notes
- In the Ribbon, click Publish changes.
- In the Publish changes dialog, select NEW to view all unpublished notes.
- Select the notes you want to publish.
- Click Publish.
Update a published note
- In the Ribbon, click Publish changes.
- Select CHANGED to view notes modified since the last publish.
- Select the notes you want to update.
- Click Publish.
Deleting renamed or removed notes from Publish happens in this same step. Deleted items are not automatically selected — you must manually check them to remove them from the live site.
Unpublish notes
Unpublishing removes a note from your site but leaves it in your local vault.- In the Ribbon, click Publish changes.
- Select UNCHANGED to view all currently published notes.
- Select the notes you want to unpublish.
- Click Publish.
Publish linked notes and attachments
If a published note links to other notes or embeds images, those linked items may show as broken unless they’re also published. Obsidian Publish helps prevent this by automatically selecting media linked from notes you’ve already chosen to publish. To include all linked notes in one step, click Add linked in the Publish changes dialog. Review the updated selection before publishing to make sure it doesn’t include anything you’re not ready to share.Automatically include notes
You can flag individual notes or entire folders so they’re automatically selected for publishing.Flag a single note
Addpublish: true to the note’s frontmatter properties:
Include an entire folder
- In the Ribbon, click Publish changes.
- Click the Manage publish filters icon (funnel).
- Under Included folders, click Manage.
- Choose the folders you want to include.
- Click Done.
Exclude notes from publishing
Exclude a single note
Addpublish: false to the note’s frontmatter properties:
Exclude an entire folder
- In the Ribbon, click Publish changes.
- Click the Manage publish filters icon (funnel).
- Under Excluded folders, click Manage.
- Choose the folders you want to exclude.
- Click Done.
If a note has
publish: true in its frontmatter, it will still be published even if it’s inside an excluded folder. Per-note settings take precedence over folder-level exclusions.Set custom URLs with permalinks
By default, a note’s URL is derived from its file path. You can override this with a permalink property:publish.obsidian.md/your-site/Company/About+us into publish.obsidian.md/your-site/about. If someone visits the original URL, they’re automatically redirected to the permalink.
Redirect old notes
When you rename or move a note, external links pointing to the old URL will break. To redirect visitors, add the old path as an alias in the new note’s frontmatter:Manage media files
Publish supports images, PDFs, audio, and video files up to 50 MB per file.Images
Images
Use
.svg, .webp, or .png formats where possible. Optimize images before uploading to reduce file size while preserving visual quality.PDFs
PDFs
Compress PDFs and remove unnecessary embedded images before uploading. Note that on mobile devices, embedded PDFs may not load or may only show the first page due to mobile renderer limitations.
Video and audio
Video and audio
Publish is not optimized for streaming large video or audio files. For multiple or large video files, host them on YouTube or Vimeo and embed the link instead.Recommended formats if hosting on Publish:
- Video:
.mp4,.webm - Audio:
.aac,.mp3,.opus
Manage multiple sites
Your Publish subscription may allow multiple sites. Each site is an independent collection of published notes.- Switch sites: In the Publish changes panel, click Switch site and then Choose next to the site you want.
- Create a site: Click Switch site, then enter a new Site ID and click Create.
- Delete a site: Click Switch site, then click the delete icon next to a site. Notes remain in your local vault after deletion.
- Change a site ID: Click Switch site, then click the edit icon next to a site to change its ID.