No description
Find a file
2025-03-17 16:26:24 +08:00
src add help doc reference logic 2025-03-17 16:26:24 +08:00
.editorconfig Initial commit 2025-02-26 10:55:52 +08:00
.eslintignore Initial commit 2025-02-26 10:55:52 +08:00
.eslintrc Initial commit 2025-02-26 10:55:52 +08:00
.gitignore Unit testing/Bug fixing 2025-03-16 21:17:19 +08:00
.npmrc Initial commit 2025-02-26 10:55:52 +08:00
esbuild.config.mjs initial 2025-02-26 14:20:31 +08:00
jest.config.js Unit testing/Bug fixing 2025-03-16 21:17:19 +08:00
LICENSE Initial commit 2025-02-26 10:55:52 +08:00
manifest.json update manifest/ fix dateformat bug 2025-03-11 18:36:00 +08:00
package-lock.json Unit testing/Bug fixing 2025-03-16 21:17:19 +08:00
package.json Unit testing/Bug fixing 2025-03-16 21:17:19 +08:00
README.md organize directory/fix sync bug 2025-03-14 09:17:14 +08:00
styles.css add help doc reference logic 2025-03-17 16:26:24 +08:00
tsconfig.json improve exist file check with id 2025-03-12 12:31:36 +08:00
version-bump.mjs Initial commit 2025-02-26 10:55:52 +08:00
versions.json Initial commit 2025-02-26 10:55:52 +08:00

Cubox Plugin for Obsidian

The official Cubox plugin for Obsidian allows you to synchronize articles and annotations from Cubox to Obsidian.

Features

  • Automatic Sync: Periodically sync articles and annotations from Cubox to Obsidian
  • Filtering: Filter content by folder, type, tags, and status
  • Templates: Customize file names, front matter, and content format
  • Annotation Sync: Sync highlighted content from Cubox to Obsidian notes

Installation

Install from the Community

  1. Open Obsidian settings
  2. Navigate to the "Community plugins" tab
  3. Click the "Browse" button and search for "Cubox"
  4. Click Install

Manual Installation

  1. Download the latest main.js, manifest.json, and styles.css files
  2. Create a .obsidian/plugins/obsidian-cubox folder in your Obsidian vault
  3. Copy the downloaded files into this folder
  4. Enable the plugin in Obsidian settings

Configuration

  1. Cubox Server Domain: Select the Cubox server domain you use (cubox.cc or cubox.pro)
  2. Cubox API Key: Enter your Cubox API key or link (generate it in the Cubox web settings under Extensions & Automation - API Extension)

Usage

  1. Before setting up, ensure you have selected the correct server and entered the API key
  2. Only content that meets all filter conditions will be synced
  3. Refer to the settings page for reference links to template variables
  4. Each item is synced only once from Cubox, updates in Cubox will not be synced to Obsidian unless you change the target folder
  5. It is recommended to set a longer sync interval or use manual sync to prevent syncing unfinished annotations

Dependencies

License

This project is licensed under the MIT License.