Skip to main content
Prime Direction

Bookmarks

Break gives every reader a private reading list. They save a post with the bookmark button, see the list in the top bar and in the Reading list section of the front page, and open the full list at /bookmarks/. Nothing is stored on your site. The list lives in the reader's own browser, so it works without a membership and without signing in.

Setup Instructions#

Bookmarks are always on. The only requirement is the routes.yaml file that ships with the theme, which creates the /bookmarks/ page. If you have not uploaded it yet, follow the Getting Started guide, otherwise the page returns a 404.

To link the page from your menu:

  1. Navigate to ⛭ Settings → Navigation
  2. Add a new item with the label Bookmarks and the URL /bookmarks/
  3. Click Save

How Readers Use It#

WhereWhat they can do
Post cardsThe bookmark icon on the card saves or removes the post
Post pageThe bookmark icon next to the share button does the same
b key on a postSaves or removes the post being read
Top barThe bookmark icon with a counter opens the saved list
Front pageThe Reading list section shows the saved posts
/bookmarks/The full list as cards

Most post cards carry the bookmark icon at the end of their info line: the post grids and archives, the cards in the navigation menu, the related posts under a post, and the front page sections such as Today, the desks, the editor's picks, the long reads and From the archive. On the wire and on the smaller rows of the front page, the icon appears over the picture while the pointer is on the card. The large featured card in the Split, Cover and Headline looks, the weekend feature, the most-read list and the opinion columns have no bookmark icon.

The top bar panel#

The bookmark icon in the top bar shows how many posts are saved. Clicking it opens a Bookmarks panel. Each row shows the post's picture, its reading time, its title and when it was saved, such as Saved 2 days ago, with a button to remove it. A View All link leads to /bookmarks/.

When nothing is saved, the panel shows Nothing saved yet, explains that bookmarks are kept on the device, and links to /blog/ to browse stories.

The Reading list on the front page#

The front page has a Reading list section with the same rows as the panel, newest saved first, and an All bookmarks link to /bookmarks/. The section stays hidden while the reader has nothing saved, so a first-time visitor never sees an empty section. See Archive and Newsroom.

The bookmarks page#

The page opens with a Bookmarks heading and the line Saved stories on this device. Below it, every saved post is a card with its picture, the time it was saved, its reading time and its title. The bookmark icon on each card is pressed, and clicking it removes the post. With nothing saved, the page shows No bookmarks yet. and a Browse stories button that leads to /blog/.

Saving the same post from two places keeps one entry. Removing it anywhere updates the counter and every list at once.

Where the List Is Stored#

The reading list is stored in the reader's browser under the local storage key break-bookmarks. It never reaches your Ghost site, so you cannot see, export or restore it.

What that means in practice:

  • No account needed. Bookmarks work for anonymous visitors, free members and paid members alike.
  • Per device and per browser. A list saved on a phone does not appear on a laptop, and Chrome does not see what Safari saved.
  • Cleared with site data. Clearing browsing data, using a private window, or a browser that discards storage on exit removes the list.
  • Not synced and not backed up. There is no copy on the server to fall back on.

Notes#

  • A saved entry keeps a copy of the title, picture and reading time from the moment it was saved. Renaming a post later does not rename the saved entry.
  • Unpublishing or deleting a post does not remove it from anyone's list. The entry stays until the reader removes it, and its link stops working.
  • The Browse stories links point at /blog/, which also comes from routes.yaml.
  • The b key only works on a post page, and not while the reader is typing in a field. The settings panel lists every keyboard shortcut. See Reading Preferences.