Cubox Support

# Obsidian Sync Plugin

The official Cubox Obsidian sync plugin allows you to synchronize articles and highlights from Cubox to Obsidian.

# Download and Installation

Enable Community Plugins:

  1. Open the Settings in Obsidian and go to Community plugins on the left menu;
  2. If it’s your first time, toggle Safe mode off by clicking “Turn on community plugins”.

Install the plugin: You can install it directly via the official link (opens new window), or:

  1. In the Community plugins section, click Browse to open the Community plugins;
  2. Search for Cubox, find the official plugin, and click Install;
  3. After installation, click Enable to activate the plugin.

# Alternative Installation (Manual)

  1. Download the latest main.js, manifest.json, and styles.css from GitHub Releases (opens new window) and place them in a folder named obsidian-cubox.
  2. Open your Obsidian plugins directory (located at .obsidian/plugins inside your current vault, or click the folder icon next to “Installed plugins” under Settings → Community plugins), then move the obsidian-cubox folder into it.
  3. Return to Obsidian, click the refresh button on the same plugin settings page, then enable the Cubox plugin. Click the gear icon to configure it.

# Connecting Obsidian with Cubox

# Select the Cubox Server

Choose the Cubox server domain you use (this document is on cubox.cc).

# Config API Key

  1. Go to Cubox Web Settings - Extensions & Automation (opens new window)
  2. Enable and copy the API link under API Extension, then paste it into the Obsidian plugin settings

# Filtering Synced Data

By default, Cubox syncs all parsed content. However, we recommend configuring the selection of folders, tags, types, and card statuses to sync only the most important information.

Once changed, only content that meets all four selection criteria will be synced. For example, you can choose to sync only items that are highlighted and read within a specific folder. This prevents unfinished annotations or unread content from being synced too early, ensuring annotations can be updated.

# Configuring Sync

Set the automatic sync interval (in minutes). We recommend setting it to 0 for manual sync or a longer interval to prevent content from syncing too early.

# Filename Template

When content is synced to Obsidian, each note's filename can be customized. Available variables:


{{{title}}} //Card title
{{{article_title}}} //Content title
{{{create_time}}} //Save date
{{{update_time}}} //Update date
{{{domain}}} //Original website domain
{{{type}}} //Content type (e.g., article, snippet...)

# Default Template


{{{card_title}}}-{{{create_time}}}

# Metadata

Stores key article attributes. You can customize which fields to include. Available variables:


title //Card title
article_title //Content title
tags //Content tags
create_time //Save date
update_time //Update date
domain //Original website domain
url //Source link
cubox_url //Cubox deep link
description //Card description
words_count //Total word count
type //Content type name (e.g., article, snippet...)

# Default Variables


cubox_url, original_url, tags

Note: Regardless of metadata settings, the id field is always included to track sync status. Do not modify or delete this field.

# Content Template

Customize the content format and structure for each note synced to Obsidian. Available variables:


{{{id}}} //Unique identifier
{{{title}}} //Card title
{{{description}}} //Card description
{{{article_title}}} //Content title
{{{content}}} //Full content text
{{{content_highlighted}}} //Full content text with highlights
{{{highlights}}} //All annotations (including highlights and notes)
  {{{highlight_text}}} //Highlighted text
  {{{image_url}}} //Highlighted image link
  {{{cubox_url}}} //Cubox deep link to highlight
  {{{note}}} //Highlighted note text
  {{{color}}} //Highlight color
  {{{create_time}}} //Highlight creation time
{{{tags}}} //Content tags
{{{update_time}}} //Update date
{{{domain}}} //Original website domain
{{{url}}} //Source link
{{{cubox_url}}} //Cubox deep link
{{{words_count}}} //Total word count

# Default Template

This template syncs basic card information, including title, description, and annotations, but does not include the full article text.

If you need to include full article, please use the Full content text variable where you want it inserted. Note: Make sure to use three braces to avoid issues.

Each Cubox card can be synced as an individual Obsidian note. You can configure whether to sync the full article text, highlights, or a combination of both. If you require a higher level of customization and are unsure whether the format is correct, you can use AI assistant to help validate it.


# {{{title}}}

{{{description}}}

[Read in Cubox]({{{cubox_url}}})  
[Read Original]({{{url}}})  

---

{{#highlights.length}}
## Annotations  

{{#highlights}}
> {{{text}}}  

{{#note}}
{{{note}}}
{{/note}}
[Link️]({{{cubox_url}}})  

{{/highlights}}
{{/highlights.length}}

# Date Format

Specify the date format used in any of the templates above. Recommended formats include:

  • yyyy-MM-dd
  • MM/dd/yyyy
  • dd.MM.yyyy
  • yyyy-MM-dd HH:mm:ss

More custom format references (opens new window)

# Sync Instructions

  1. Click the Cubox extension icon in the Obsidian interface to trigger a manual sync. If a sync interval is set, the plugin will automatically fetch newly saved articles on a regular basis.
  2. Each Cubox item is synced only once to the target folder in Obsidian. Resync only happens if you delete the original note in Obsidian and update the card in Cubox (like changing the title or description).
  3. To re-sync all content, you can update the target folder in the Cubox plugin settings and set a new, unused folder.
  4. Please do not edit or remove the id field at the top of synced notes. This may cause sync errors.

← Widgets →