WeChat Sync with VixNote

pending

by PeterQin

Sync messages from the VixNote WeChat official account into your Vault. Learn more at vixnote.com.

Updated 10d agoMITDiscovered via Obsidian Unofficial Plugins
View on GitHub

WeChat Sync with VixNote

Sync messages from the VixNote WeChat official account into your Obsidian Vault.

VixNote helps users leave messages in a WeChat official account and automatically sync them into a chosen folder inside Obsidian. Messages are grouped into daily notes, which makes the plugin useful for journaling, quick capture, and personal knowledge management.

What This Repository Contains

This repository is a monorepo with three main parts:

  • apps/api: the backend that receives WeChat messages, handles OAuth/login, stores users/messages, and exposes sync APIs
  • apps/web: the VixNote setup and management web app
  • apps/obsidian-plugin: the Obsidian plugin that pulls messages into a local Vault

Obsidian Plugin

  • Plugin ID: vixnote-sync
  • Plugin name: WeChat Sync with VixNote
  • Minimum Obsidian version: 1.5.0

The plugin lets a user:

  • connect Obsidian to their VixNote account with a stable plugin token
  • sync WeChat official account messages into a target folder in their Vault
  • auto-create daily notes such as 20260326｜周四｜日记.md
  • keep syncing in the background while Obsidian is open

Install The Plugin Manually

  1. Download the latest plugin files from the GitHub Release assets or from vixnote.com.
  2. Copy main.js, manifest.json, and styles.css into:
<your-vault>/.obsidian/plugins/vixnote-sync/
  1. Open Obsidian.
  2. Go to Settings -> Community plugins.
  3. Turn off restricted mode if needed.
  4. Enable WeChat Sync with VixNote.

Plugin settings:

  • API Base URL: https://api.vixnote.com
  • Plugin Token: generated for the logged-in WeChat user in VixNote setup
  • Sync Folder: target folder inside the Vault, for example 日记

User Flow

  1. Follow the VixNote WeChat service account.
  2. Open the setup page at vixnote.com/setup.
  3. Sign in with WeChat and save the target Obsidian path.
  4. Copy the plugin token.
  5. Install the Obsidian plugin and paste the token.
  6. Leave a message in the VixNote official account.
  7. The message syncs into the local Obsidian Vault.

Local Development

Install dependencies:

npm install

Start the backend:

npm run dev:api

Start the web app:

npm run dev:web

Build the plugin:

npm run plugin:build

Prepare community release assets:

npm run plugin:release

Community Plugin Submission Files

The root of this repository includes the files Obsidian expects when reviewing a community plugin:

  • manifest.json
  • versions.json
  • README.md
  • LICENSE

Additional release instructions are in:

Release Assets

The prepared release assets are generated into:

dist/obsidian-community/<version>/

That folder contains:

  • main.js
  • manifest.json
  • styles.css
  • vixnote-sync-<version>.zip

Current Status

The repository is ready for:

  • public GitHub presentation
  • first GitHub Release packaging
  • submitting the plugin to Obsidian's community plugin review

The final community marketplace listing still requires a submission to the official Obsidian review repository and waiting for review approval.

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.