Skip to main content
Prime Direction

Break

News Ghost theme with a front page that scrolls sideways: a live desk, a markets tape, a section per desk and a top bar with a clock, quotes and breaking flashes.

Break is built for news desks that publish through the day. The front page puts breaking stories, the latest posts, several desks and market quotes on one page, and it marks what is new for readers who come back several times a day.

What makes it different#

  • A front page that scrolls sideways. On a desktop the sections stand side by side and the page moves left to right. On a phone they stack. See Front Page Overview and Reading Mode.
  • A live desk. Tag a post #breaking and it appears in the live column next to the featured post, flashes in the top bar for 24 hours and joins the /live/ page, which refreshes itself. See Live Updates.
  • A section per desk. Name the tags in one setting and each gets its own section of the front page, in three looks that take turns. See Desks.
  • Market quotes. Crypto and currency quotes run in the top bar, and a card per market pairs the quote with your latest story about it. See Markets.
  • Four looks for the featured post: Split, Cover, Headline and Grid. See Featured.
  • Sections written as pages. By the numbers and the week ahead are ordinary Ghost pages, so editors update them in the editor. See Numbers and Agenda.
  • Reader tools: bookmarks and a reading list that need no account, marks on stories published since the last visit, reading preferences, light and dark, and keyboard shortcuts. See Bookmarks and Reading Preferences.

Before you start#

  1. Install the theme. Break needs Ghost 6.39 or newer. See Getting Started.
  2. Upload routes.yaml. Break ships one. Upload it in ⛭ Settings → Labs → Routes. Without it, the /blog/, /projects/, /newsletters/, /issues/ and /bookmarks/ pages return 404, and posts tagged #newsletter show up on the front page.
  3. Skim Internal Tags. Most front page sections are filled by tagging a post, and that page lists every tag on one screen.

How the documentation is organised#

  • Front Page: every section of the front page, in the order readers see them.
  • Site Wide: the reading mode, the top bar, colours, dark mode, navigation, ads and optional features.
  • Posts: internal tags, the reading experience, audio and video.
  • Pages: the pages that come with the theme, such as live, video, podcast, archive and membership.
  • Advanced: comments, search, filters, code injection and analytics.