mirror of
https://github.com/olcubo/obsidian-cubox.git
synced 2026-07-22 05:43:25 +00:00
No description
| src | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .npmrc | ||
| esbuild.config.mjs | ||
| jest.config.js | ||
| LICENSE | ||
| manifest.json | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| styles.css | ||
| tsconfig.json | ||
| version-bump.mjs | ||
| versions.json | ||
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
- Open Obsidian settings
- Navigate to the "Community plugins" tab
- Click the "Browse" button and search for "Cubox"
- Click Install
Manual Installation
- Download the latest
main.js,manifest.json, andstyles.cssfiles - Create a
.obsidian/plugins/obsidian-cuboxfolder in your Obsidian vault - Copy the downloaded files into this folder
- Enable the plugin in Obsidian settings
Configuration
- Cubox Server Domain: Select the Cubox server domain you use (cubox.cc or cubox.pro)
- Cubox API Key: Enter your Cubox API key or link (generate it in the Cubox web settings under Extensions & Automation - API Extension)
Usage
- Before setting up, ensure you have selected the correct server and entered the API key
- Only content that meets all filter conditions will be synced
- Refer to the settings page for reference links to template variables
- Each item is synced only once from Cubox, updates in Cubox will not be synced to Obsidian unless you change the target folder
- 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.