Merge pull request #2 from semanticdata/feat/brand-new-redesign

Author: semanticdata

.github/workflows/web-ext-workflow.yml

@@ -2,11 +2,11 @@ name: Release new version
 
 on:
   workflow_dispatch:
-#   push:
-#     tags:
-#       - 'v*.*.*'
-#   release:
-#     types: [published]
+  # push:
+  #   tags:
+  #     - 'v*.*.*'
+  # release:
+  #   types: [published]
 
 jobs:
   build-release:
@@ -22,7 +22,7 @@ jobs:
         uses: kewisch/action-web-ext@v1
         with:
           cmd: build
-          filename: '{name}-{version}.xpi'
+          filename: "{name}-{version}.xpi"
           ignoreFiles: '[ "package.json", "package-lock.json", "yarn.lock", ".github", ".gitattributes", "LICENSE", "README.md"]'
 
       - name: Sign

.gitignore

@@ -0,0 +1,10 @@
+node_modules
+
+# Build output - avoids duplicates and forces fresh builds
+packages/sidebar/styles.css
+packages/sidebar/script.js
+packages/sidebar/icon.svg
+packages/newtab/styles.css
+packages/newtab/script.js
+packages/newtab/icon.svg
+web-ext-artifacts

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Miguel Pimentel
+Copyright (c) 2024-2026 Miguel Pimentel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,32 +1,90 @@
-<h1><img src="./src/icons/icon32.png" height="28px" width="28px" /> NoteKeeper</h1>
+> [!NOTE]
+> NoteKeeper v2 is now available as two separate extensions that sync notes with each other. Install both for the best experience!
+
+<h1><img src="./shared/icon.svg" height="28px" width="28px" /> NoteKeeper</h1>
 
 ![Mozilla Add-on](https://img.shields.io/amo/v/newtab-notes@semanticdata) ![Add-on rating](https://img.shields.io/amo/rating/newtab-notes@semanticdata) ![Add-on downloads](https://img.shields.io/amo/dw/newtab-notes@semanticdata) ![Add-on users](https://img.shields.io/amo/users/newtab-notes@semanticdata) ![License](https://img.shields.io/github/license/semanticdata/firefox-new-tab-notes)
 
-NoteKeeper is a Firefox extension that transforms the new tab into a minimalist, auto-saving text editor. It now comes with a new sidebar companion! If you are curious, go check out the [demo](https://semanticdata.github.io/notekeeper/).
+[NoteKeeper](https://addons.mozilla.org/en-US/firefox/addon/notekeeper/) replaces the new tab page with a simple text editor. Your notes auto-save and sync across devices via Firefox Sync. The companion [NoteKeeper Sidebar](https://addons.mozilla.org/en-US/firefox/addon/notekeeper-sidebar/) extension adds a sidebar editor that syncs with the new tab version.
 
 <a href="https://addons.mozilla.org/en-US/firefox/addon/notekeeper/">
 <img src="https://raw.githubusercontent.com/semanticdata/text-revealer-firefox-extension/master/firefox.png" alt="firefox addon" /></a>
 
-## ✨ Features
+## What it does
+
+Both extensions share notes via Firefox Sync:
+
+### NoteKeeper (New Tab)
+
+- [x] Auto-saves as you type (debounced, not on every keystroke)
+- [x] Syncs notes across devices via Firefox Sync
+- [x] Dark/light theme, follows your system preference
+- [x] Adjustable font size
+- [x] Works offline
+
+### NoteKeeper Sidebar (Companion)
+
+- [x] All features of NoteKeeper
+- [x] Opens in Firefox sidebar (Alt+Shift+N)
+- [x] Syncs with NoteKeeper (notes appear in both extensions)
+- [x] Keyboard shortcut customization
+
+## Testing Checklist
+
+NoteKeeper (New Tab):
+
+- [x] Open new tab - should show NoteKeeper editor
+- [ ] Type text - should auto-save (status shows "Saved")
+- [x] Toggle theme - dark/light modes work
+- [ ] Adjust font size - slider changes text size
+- [ ] Refresh page - notes persist
+- [ ] Check word count - updates as you type
+
+NoteKeeper Sidebar:
+
+- [ ] Press `Alt+Shift+N` - sidebar opens
+- [ ] Type text in sidebar - should auto-save
+- [x] Toggle theme in sidebar - works
+- [ ] Adjust font size in sidebar - works
+- [ ] Open extension options - keyboard shortcut config appears
+- [ ] Change keyboard shortcut - saves successfully
+
+Test Sync Between Extensions:
+
+- [ ] Type in new tab → appears in sidebar
+- [ ] Type in sidebar → appears in new tab
+- [ ] Change theme in new tab → changes in sidebar
+- [ ] Change font size in new tab → changes in sidebar
+- [ ] Open two tabs - both sync notes
+- [ ] Close/reopen new tab - notes restored
+- [ ] Close/reopen sidebar - notes restored
+
+Test Offline Mode:
+
+- [ ] Disconnect internet
+- [ ] Type in new tab - saves (to local storage)
+- [ ] Type in sidebar - saves
+- [ ] Reconnect internet - syncs to Firefox Sync
+- [ ] Notes persist across devices
+
+Test Cross-Tab Sync:
 
-- ✅ Auto-saves content after every keystroke
-- ✅ Integrated with Firefox Sync - access your notes across browser instances
-- ✅ Integrated with [Web Storage API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API)
-- ✅ Works offline with browser sync support ([Firefox Sync](https://www.mozilla.org/en-US/firefox/features/sync/), [Chrome Sync](https://support.google.com/chrome/answer/185277))
-- ✅ Dark/Light themes with system preference detection
-- ✅ Responsive design that works across devices
-- ✅ Sidebar companion for quick access
-- ✅ Comprehensive test coverage
+- [ ] Open multiple new tabs
+- [ ] Type in one tab - updates others
+- [ ] Switch between tabs - notes sync
+- [ ] Open sidebar - notes match new tab
 
-## 🖼️ Screenshots
+<!--
+## Screenshots
 
 | ![light-mode](./screenshot.png) | ![dark-mode](./screenshot-dark.png) |
-| :---: | :---: |
+| :-----------------------------: | :---------------------------------: |
+-->
 
-## 💜 Acknowledgments
+## Acknowledgments
 
-This extension is based on [Tab Notes](https://github.com/nsht/tab_notes). It hadn't received updates in over 4 years when originally forked.
+This extension is based on [Tab Notes](https://github.com/nsht/tab_notes). It hadn't received updates in over 6 years last time I checked.
 
-## © License
+## License
 
-Source code in this repository is available under the [MIT License](./LICENSE).
+Available under the [MIT License](./LICENSE).

manifest.json

@@ -1,7 +1,7 @@
 {
   "manifest_version": 2,
   "name": "NoteKeeper",
-  "version": "1.3.0",
+  "version": "2.0.0",
   "description": "NoteKeeper transforms your new tab into a minimalist, auto-saving text editor.",
   "author": "semanticdata",
   "browser_specific_settings": {
@@ -14,20 +14,29 @@
     "storage"
   ],
   "icons": {
-    "48": "src/icons/icon48.png",
-    "96": "src/icons/icon96.png"
+    "32": "src/icon.svg",
+    "48": "src/icon.svg",
+    "64": "src/icon.svg",
+    "96": "src/icon.svg",
+    "128": "src/icon.svg"
   },
   "browser_action": {
     "default_title": "NoteKeeper",
     "default_icon": {
-      "48": "src/icons/icon48.png",
-      "96": "src/icons/icon96.png"
+      "32": "src/icon.svg",
+      "48": "src/icon.svg",
+      "64": "src/icon.svg",
+      "96": "src/icon.svg",
+      "128": "src/icon.svg"
     }
   },
   "sidebar_action": {
     "default_icon": {
-      "48": "src/icons/icon48.png",
-      "96": "src/icons/icon96.png"
+      "32": "src/icon.svg",
+      "48": "src/icon.svg",
+      "64": "src/icon.svg",
+      "96": "src/icon.svg",
+      "128": "src/icon.svg"
     },
     "default_title": "NoteKeeper",
     "default_panel": "src/sidebar/panel.html"