README file from
GithubMails Blog Publisher
Publish notes from Obsidian to Mails Blog. This plugin is for people who already use Mails Blog and want to draft, publish, sync, and upload images without leaving Obsidian.
What It Does
- Save the current note as a draft
- Publish the current note
- Sync a linked note back from Mails Blog
- Upload an image from the vault and insert the returned Markdown
- Write blog binding metadata back into frontmatter automatically
Requirements
- A Mails Blog account
- The Mails iOS app to generate an
Obsidian Plugin Token - A reachable
Blog API Base URL - This plugin only publishes to Mails Blog
Install
If the plugin is available in the Obsidian Community Plugins directory:
- Open
Settings -> Community plugins -> Browse. - Search for
Mails Blog Publisher. - Install and enable the plugin.
For a manual install or an unreleased build:
- Copy these files into your vault plugin folder:
manifest.jsonmain.jsstyles.css
- Target folder example:
<your-vault>/.obsidian/plugins/mails-blog-publisher/
- Enable
Mails Blog Publisherin Obsidian community plugins.
If you build from source, run npm run release:package to create a ready-to-copy release/mails-blog-publisher/ folder.
Setup
- In iOS, open
Settings -> Obsidian Plugin. - Generate a token for this Obsidian device and copy it.
- Open Obsidian plugin settings for
Mails Blog Publisher. - Fill in:
Blog API Base URLObsidian Plugin Token
- Run
Test Connection.
If the token stops working later, generate a new one in iOS and paste it again.
Publish A Note
- Open a Markdown note in Obsidian.
- Optional frontmatter fields:
titlecategorytagscard_image
- Run
Mails Blog: Save Current Note as Draftto create or update the remote draft. - Run
Mails Blog: Publish Current Noteto publish it.
The plugin writes the blog link and sync metadata back into frontmatter automatically.
Typical Workflow
- Write in Obsidian as usual.
- Save a draft to create or update the linked remote post.
- Publish when you are ready to make it live.
- Use
Sync Current Note From Blogif the remote post changed elsewhere. - Use
Upload Imageto choose a local image file and insert uploaded image Markdown into the current note.
Other Commands
Mails Blog: Sync Current Note From Blog- pulls the linked blog post back into the current note when it is safe to do so
Mails Blog: Unlink Current Note from Blog Post- removes only the local link to the remote post
Mails Blog: Upload Image- choose a local
jpg,jpeg,png,webp, orgifimage file to upload
- choose a local
Notes
Publish Current Notealways saves a draft first.Sync Current Note From Blogstops when both the local note and the remote post changed.- The plugin uploads notes or images only when you explicitly run one of its commands.
Current Limitations
- Token generation currently starts in the Mails iOS app.
- Supported image formats are
jpg,jpeg,png,webp, andgif. - When both the local note and the remote post changed, sync stops instead of trying to merge them automatically.
Privacy And Network Use
- This plugin connects to your configured
Blog API Base URL. - It sends your plugin token, note title, frontmatter metadata, note body, and the image file you explicitly choose only when you run publish, draft, sync, or image upload commands.
- It writes blog binding metadata back into note frontmatter and can replace the current note when you run
Sync Current Note From Blog. - It does not include ads or telemetry.
For implementation and maintenance details, see AI_HANDOFF.md.