Halo

Obsidian plugin for Halo

This plugin allows you to publish your Obsidian documents to Halo.

中文文档

Preview

Usage

1. Search for "Halo" in Obsidian's community plugins browser.
2. Click Install.
3. Go to Settings -> Community Plugins -> Halo and configure the settings.
4. Create a new site:

   1. Site name: the name of the site, optional.

   2. Site URL: the URL of the site, e.g. https://example.com.

   3. Personal access token: The personal access token of your Halo site, needs Post Manage permission.

      

      More information about personal access token: Personal Access Token

   4. Set as default: set the site as the default site.

5. Open a note you want to publish, and run the command Halo: Publish to Halo.
6. All available commands:
   • Halo: Publish to Halo: publish the current note to Halo.
   • Halo: Publish to Halo (use default settings): publish the current note to the default site.
   • Halo: Upload images to Halo: upload local images in the current note to Halo and replace them with remote URLs.
   • Halo: Pull posts from Halo: pull posts from Halo to Obsidian.
   • Halo: Update content from Halo: update the content of the current note from Halo.

Development

1. Create a new Obisidian vault for development.

2. Clone this repo to the plugins folder of the newly created vault.

   cd path/to/vault/.obsidian/plugins
   
   git clone https://github.com/ruibaby/obsidian-halo
   

3. Install dependencies

   cd obsidian-halo
   
   npm install
   

4. Build the plugin

   npm run dev
   

5. Reload Obsidian and enable the plugin in Settings.

Credits

• obsidian-wordpress: the original idea came from this repo.

TODO

• i18n
• Upload images
• Publish this plugin to Obsidian community