Skip to main content

Getting Started

This guide will walk you through adding your first bookmark repo to BookmarkRepo.

Opening the Options Page​

  1. Click the extension icon in your browser toolbar, or
  2. Right-click the extension icon and select "Options"

You'll see the "Manage Bookmark Repos" page, which is where you configure all your bookmark repos.

Adding Your First Repo​

Step 1: Click "Add Repo"​

Click the "Add Repo" button to start the repo configuration wizard.

Step 2: Select Repo Type​

Choose the type of repo you want to add:

  • HTTP API - For bookmarks from an HTTP endpoint (JSON or YAML format)
  • Confluence Page - For bookmarks extracted from a Confluence page

Click "Next" to continue.

Step 3: Configure Repo Details​

The configuration options depend on the repo type you selected:

For HTTP API Repos​

  1. Name - Enter a name for this repo (e.g., "My API Bookmarks")
    • This name will be used as the folder name in your bookmarks
  2. URL - Enter the full URL of the API endpoint
  3. Format - Select the response format (JSON or YAML)
  4. Target Folder - Select where bookmarks should be stored
    • Click "Select Target Folder" to browse your existing bookmarks
    • The repo will create a new folder with the repo name inside the target folder
  5. Frequency - Choose how often to sync:
    • Every 10 minutes
    • Every hour
    • Twice a day
    • Once a day
    • Once a week

For Confluence Repos​

  1. Name - Enter a name for this repo
  2. Confluence URL - Enter the URL of the Confluence page containing bookmarks
  3. Target Folder - Select where bookmarks should be stored
  4. Frequency - Choose how often to sync

Step 4: Save​

Click "Save" to create the repo. The extension will validate your configuration and may test the connection.

Testing Your Repo​

After saving, you can immediately test your repo:

  1. Find your repo in the list
  2. Click the "Fetch" button (or "Fetch now" tooltip)
  3. Check the status - you should see "Repo synced successfully" if everything worked
  4. Check your bookmarks - you should see a new folder with the repo name containing the synced bookmarks

Viewing Sync History​

To see the history of sync operations:

  1. Click the "History" button next to any repo
  2. View the list of all fetch operations, including:
    • Timestamp
    • Status (Success/Error)
    • Number of bookmarks fetched
    • Error details (if any)

Editing or Deleting Repos​

  • Edit: Click the "Edit" button next to a repo to modify its configuration
  • Delete: Click the "Delete" button to remove a repo (this will also remove the bookmark folder)

Next Steps​