Skip to content

Latest commit

 

History

History
126 lines (90 loc) · 7.06 KB

README.md

File metadata and controls

126 lines (90 loc) · 7.06 KB

NotchNotes

A notepad that lives in your MacBook's notch.

Hover over the notch and a panel drops down with your notes, a checklist, any web page or a terminal. Move away and it disappears. There is no Dock icon, no menu bar icon and no window to manage.

Website · Features · Install · Usage · Your notes · Build from source

A tour of NotchNotes: notes, checklists, lists, web pages, the terminal, Org mode, screen sharing and updates, each shown in the panel under the notch

Requirements: macOS 13 Ventura or later. Designed for Macs with a notch; on other Macs the panel sits at the top center of the screen.

Features

Notes

  • Saved as you type: notes are plain text files, restored the next time the app opens.
  • Several notes: the dots under the text switch between notes, and + starts a new one.
  • Checklists: type - [ ] item or use the checklist button. Click a box to check it; checked items are struck through and move below the unchecked ones.
  • Numbered and bulleted lists: Enter continues the list and keeps the numbers in order. Tab and Shift-Tab move an item in or out a level.
  • Links: addresses in your notes are underlined. ⌘-click one to open it in the panel.
  • Font size: set the editor font from 10 to 24 pt in the toolbar.

Web pages

  • Any page in the panel: type an address in the URL field and press Return. Text that isn't an address runs a web search. The page is remembered across launches.
  • Mobile or desktop site: one button switches between the two.
  • Audio indicator: a page keeps playing after the panel closes, and a thin line pulses around the notch while it does.
  • Downloads: files are saved to your Downloads folder.
  • Local addresses: localhost, .local and bare IP addresses load over http.
  • Light and dark: pages follow the system appearance. The panel itself is always dark.

Terminal

  • A shell in the panel: the terminal button, or ⌘T, swaps the notes or the page for your login shell, started in your home folder. Full-screen programs such as Emacs (for Org mode), Vim or htop run in it.
  • Several terminals: the dots under the terminal switch between shells, and + starts another. ⌘N and ⌘⇧[ / ⌘⇧] work on them as they do on notes.
  • Keeps running: the shells and whatever runs in them stay alive while the panel is closed or showing the notes or a page. exit ends one; after the last, the next ⌘T starts a new one.
  • Option is Meta: Option-key combinations reach the program as Meta, as Emacs expects. ⌘⌥O switches that off and on.
  • Font size: shared with the notes.

The panel

  • Opens on hover or by hotkey: rest the mouse on the notch, or press ⌃⌥N from any app.
  • Lock open: the lock button keeps the panel open when the mouse leaves, and stays set across launches.
  • Resizable: drag a bottom corner, or the left, right or bottom edge. The size is remembered.
  • Hidden from screen sharing: by default the panel is left out of screen recordings and screen shares. The eye button shows it.
  • Stays in front: the panel returns to the front when another app's overlay, such as a screen-share border, covers it.
  • Fits any width: toolbar buttons that don't fit move into a … tray.
  • Follows your displays: the panel moves with the notch when displays are added, removed or rearranged.
  • Accessible: toolbar buttons and fields are labelled for VoiceOver.

Updates

NotchNotes checks its GitHub releases at launch. When a newer version is available, a cloud button appears next to the quit button; hover it to see the version. Click it and the app downloads the release, replaces itself and relaunches.

The button goes away once the panel has been open for a minute, and returns at the next launch.

Install

  1. Download NotchNotes-vX.Y.Z.zip from the latest release.

  2. Unzip it and move NotchNotes.app to /Applications.

  3. If macOS blocks the app from opening, you may need to remove its quarantine attribute. NotchNotes is currently ad-hoc signed and is not notarized by Apple. Only proceed if you trust the downloaded release.

    xattr -dr com.apple.quarantine /Applications/NotchNotes.app
  4. Open the app and hover over the notch.

Later versions arrive through the update button, so these steps are not repeated.

Start at login (optional): System Settings → General → Login Items → + → select NotchNotes.app.

Usage

Action How
Open the panel Hover over the notch, or press ⌃⌥N
Close the panel Move the mouse away, press ⌃⌥N, or press Esc while in the notes (a page or the terminal keeps Esc for itself)
New note or terminal Click + after the dots, or press ⌘N
Switch notes or terminals Click a dot, or press ⌘⇧[ / ⌘⇧]. From the last one, ⌘⇧] starts a new one
Check or uncheck an item Click its box
Indent a list item Tab / Shift-Tab
Open a link from the notes ⌘-click it
Open or leave the terminal Click the terminal button, or press ⌘T
Go to the URL field ⌘L
Load a page Type an address or a search, then press Return
Back, forward, reload ⌘[ / ⌘] / ⌘R
Return to the notes Click × in the URL field, or clear the field and press Return
Resize the panel Drag a bottom corner, or the left, right or bottom edge
Quit Click the red dot in the top left, or press ⌘Q

The standard editing shortcuts (⌘A, ⌘C, ⌘V, ⌘X, ⌘Z, ⌘⇧Z) work as usual.

Your notes

Notes are plain text files in ~/Library/Application Support/NotchNotes: notes.txt, then notes-2.txt, notes-3.txt and so on.

  • The first save of each launch keeps the previous version as notes.txt.bak.
  • A file that can't be read is never saved over.
  • A note left empty is removed.

To keep the notes somewhere else, such as a synced folder, set the folder and relaunch:

defaults write com.local.notchnotes notesFolder ~/path/to/folder

Build from source

Requires Swift, which ships with Xcode and the Xcode Command Line Tools.

git clone https://github.com/devadula-nandan/notch-notes.git
cd notch-notes
bash make-app.sh      # release build, ad-hoc signed
open NotchNotes.app
Script What it does
bash make-app.sh Builds a self-contained NotchNotes.app in the project root.
bash dev.sh Builds in debug mode, launches the app, and rebuilds and relaunches it when a file under Sources/ or Package.swift changes. A failed build leaves the previous one running. It quits an installed NotchNotes.app first, since both would share the same notes. Ctrl+C stops it.
bash test.sh Runs the tests for the text, address and storage logic in Sources/NotchNotesCore. With full Xcode installed, swift test works as well.

License

MIT. See LICENSE.