Skip to content

Commit 4fb2809

Browse files
authored
Merge pull request #3 from semanticdata/chore/forgotten-updates
2 parents 1899deb + f790706 commit 4fb2809

15 files changed

Lines changed: 47 additions & 157 deletions

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ node_modules
44
packages/sidebar/styles.css
55
packages/sidebar/script.js
66
packages/sidebar/icon.svg
7+
packages/sidebar/preload.js
78
packages/newtab/styles.css
89
packages/newtab/script.js
910
packages/newtab/icon.svg
11+
packages/newtab/preload.js
1012
web-ext-artifacts

README.md

Lines changed: 16 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,37 @@
1-
> [!NOTE]
2-
> NoteKeeper v2 is now available as two separate extensions that sync notes with each other. Install both for the best experience!
3-
41
<h1><img src="./shared/icon.svg" height="28px" width="28px" /> NoteKeeper</h1>
52

63
![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)
74

8-
[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.
5+
[NoteKeeper](https://addons.mozilla.org/en-US/firefox/addon/notekeeper/) turns your new tab into a simple text editor. Notes auto-save and sync across devices via Firefox Sync.
6+
7+
Install both extensions for the best experience — the [companion sidebar](https://addons.mozilla.org/en-US/firefox/addon/notekeeper-sidebar/) gives you quick access from any page.
98

109
<a href="https://addons.mozilla.org/en-US/firefox/addon/notekeeper/">
1110
<img src="https://raw.githubusercontent.com/semanticdata/text-revealer-firefox-extension/master/firefox.png" alt="firefox addon" /></a>
1211

13-
## What it does
12+
## Features
1413

15-
Both extensions share notes via Firefox Sync:
14+
Both extensions sync notes via Firefox Sync. But the can't share notes with each other due to some browser limitations.
1615

1716
### NoteKeeper (New Tab)
1817

19-
- [x] Auto-saves as you type (debounced, not on every keystroke)
20-
- [x] Syncs notes across devices via Firefox Sync
21-
- [x] Dark/light theme, follows your system preference
22-
- [x] Adjustable font size
23-
- [x] Works offline
18+
- Auto-saves as you type
19+
- Syncs across devices via Firefox Sync
20+
- Dark/light theme follows your system
21+
- Adjustable font size
22+
- Works offline
2423

2524
### NoteKeeper Sidebar (Companion)
2625

27-
- [x] All features of NoteKeeper
28-
- [x] Opens in Firefox sidebar (Alt+Shift+N)
29-
- [x] Syncs with NoteKeeper (notes appear in both extensions)
30-
- [x] Keyboard shortcut customization
31-
32-
## Testing Checklist
33-
34-
NoteKeeper (New Tab):
35-
36-
- [x] Open new tab - should show NoteKeeper editor
37-
- [ ] Type text - should auto-save (status shows "Saved")
38-
- [x] Toggle theme - dark/light modes work
39-
- [ ] Adjust font size - slider changes text size
40-
- [ ] Refresh page - notes persist
41-
- [ ] Check word count - updates as you type
42-
43-
NoteKeeper Sidebar:
44-
45-
- [ ] Press `Alt+Shift+N` - sidebar opens
46-
- [ ] Type text in sidebar - should auto-save
47-
- [x] Toggle theme in sidebar - works
48-
- [ ] Adjust font size in sidebar - works
49-
- [ ] Open extension options - keyboard shortcut config appears
50-
- [ ] Change keyboard shortcut - saves successfully
51-
52-
Test Sync Between Extensions:
53-
54-
- [ ] Type in new tab → appears in sidebar
55-
- [ ] Type in sidebar → appears in new tab
56-
- [ ] Change theme in new tab → changes in sidebar
57-
- [ ] Change font size in new tab → changes in sidebar
58-
- [ ] Open two tabs - both sync notes
59-
- [ ] Close/reopen new tab - notes restored
60-
- [ ] Close/reopen sidebar - notes restored
61-
62-
Test Offline Mode:
63-
64-
- [ ] Disconnect internet
65-
- [ ] Type in new tab - saves (to local storage)
66-
- [ ] Type in sidebar - saves
67-
- [ ] Reconnect internet - syncs to Firefox Sync
68-
- [ ] Notes persist across devices
69-
70-
Test Cross-Tab Sync:
71-
72-
- [ ] Open multiple new tabs
73-
- [ ] Type in one tab - updates others
74-
- [ ] Switch between tabs - notes sync
75-
- [ ] Open sidebar - notes match new tab
26+
- Opens in Firefox sidebar (Alt+Shift+N)
27+
- Syncs with the new tab version
28+
- Customize keyboard shortcut
29+
- All features of NoteKeeper
7630

77-
<!--
7831
## Screenshots
7932

80-
| ![light-mode](./screenshot.png) | ![dark-mode](./screenshot-dark.png) |
81-
| :-----------------------------: | :---------------------------------: |
82-
-->
33+
| ![new tab screenshot](./screen-newtab.png) | ![sidebar screenshot](./screen-sidebar.png) |
34+
| :----------------------------------------: | :-----------------------------------------: |
8335

8436
## Acknowledgments
8537

manifest.json

Lines changed: 0 additions & 64 deletions
This file was deleted.

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@
1010
"watch": "node scripts/watch-shared.js",
1111
"dev:newtab": "npm run build && web-ext run --source-dir packages/newtab",
1212
"dev:sidebar": "npm run build && web-ext run --source-dir packages/sidebar",
13+
"lint:newtab": "npm run build && web-ext lint --source-dir packages/newtab",
14+
"lint:sidebar": "npm run build && web-ext lint --source-dir packages/sidebar",
1315
"package:newtab": "npm run build && web-ext build --source-dir packages/newtab",
1416
"package:sidebar": "npm run build && web-ext build --source-dir packages/sidebar",
15-
"package:all": "npm run build && web-ext build --source-dir packages/newtab && web-ext build --source-dir packages/sidebar"
17+
"package:all": "npm run build && web-ext build --source-dir packages/newtab --overwrite-dest && web-ext build --source-dir packages/sidebar --overwrite-dest"
1618
},
1719
"devDependencies": {
1820
"web-ext": "^9.2.0"
@@ -33,4 +35,4 @@
3335
"url": "https://github.com/semanticdata/notekeeper/issues"
3436
},
3537
"homepage": "https://github.com/semanticdata/notekeeper#readme"
36-
}
38+
}

packages/newtab/manifest.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77
"browser_specific_settings": {
88
"gecko": {
99
"id": "newtab-notes@semanticdata",
10-
"strict_min_version": "100.0"
10+
"strict_min_version": "142.0",
11+
"data_collection_permissions": {
12+
"required": ["none"]
13+
}
1114
}
1215
},
1316
"permissions": [

packages/newtab/src/newtab.html

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,7 @@
99
content="NoteKeeper is a Firefox extension that transforms the New Tab into a minimalist, auto-saving text editor.">
1010
<link rel="icon" type="image/svg+xml" href="../icon.svg" />
1111
<link rel="stylesheet" href="../styles.css" />
12-
<script>
13-
// Prevent FOUC
14-
const savedTheme = localStorage.getItem("theme");
15-
const sysTheme = window.matchMedia("(prefers-color-scheme: dark)").matches;
16-
document.documentElement.setAttribute("data-theme", savedTheme || (sysTheme ? "dark" : "light"));
17-
// Pre-load font size
18-
const savedSize = localStorage.getItem("fontsize");
19-
if (savedSize) document.documentElement.style.setProperty('--note-size', savedSize);
20-
</script>
12+
<script src="../preload.js"></script>
2113
</head>
2214

2315
<body>

packages/sidebar/manifest.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77
"browser_specific_settings": {
88
"gecko": {
99
"id": "sidebar-notes@semanticdata",
10-
"strict_min_version": "100.0"
10+
"strict_min_version": "142.0",
11+
"data_collection_permissions": {
12+
"required": ["none"]
13+
}
1114
}
1215
},
1316
"permissions": [

packages/sidebar/src/panel.html

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,19 @@
44
<head>
55
<meta charset="UTF-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>NoteKeeper</title>
7+
<title>NoteKeeper Companion</title>
88
<meta name="description"
9-
content="NoteKeeper is a Firefox extension that transforms the New Tab into a minimalist, auto-saving text editor.">
9+
content="NoteKeeper Companion is a Firefox extension that transforms the sidebar into a minimalist, auto-saving text editor.">
1010
<link rel="icon" type="image/svg+xml" href="../icon.svg" />
1111
<link rel="stylesheet" href="../styles.css" />
12-
<script>
13-
// Prevent FOUC
14-
const savedTheme = localStorage.getItem("theme");
15-
const sysTheme = window.matchMedia("(prefers-color-scheme: dark)").matches;
16-
document.documentElement.setAttribute("data-theme", savedTheme || (sysTheme ? "dark" : "light"));
17-
// Pre-load font size
18-
const savedSize = localStorage.getItem("fontsize");
19-
if (savedSize) document.documentElement.style.setProperty('--note-size', savedSize);
20-
</script>
12+
<script src="../preload.js"></script>
2113
</head>
2214

2315
<body>
2416
<header>
2517
<div style="display: flex; align-items: center; gap: 0.25rem;">
2618
<img src="../icon.svg" alt="NoteKeeper Logo" width="24" height="24" />
27-
<span class="brand">NoteKeeper</span>
19+
<span class="brand">NoteKeeper Companion</span>
2820
</div>
2921

3022
<button id="theme-toggle" aria-label="Toggle theme">

screen-newtab.png

4.44 KB
Loading

screen-sidebar.png

4.62 KB
Loading

0 commit comments

Comments
 (0)