Projects
Not everything a newsroom makes is a story. Break keeps a separate list for the things you build, such as data tools, investigations and series. A post tagged #project is shown as a project card on the /projects/ page and in the projects block of the navigation menu.
Setup Instructions#
- Create a post for the project
- Open Post settings → Tags and add the internal tag
#project - Add a feature image
- Write a short summary in Post settings → Excerpt
- Add the public tags that describe the work, with the most important one first
- Click Publish
Use an internal tag that starts with # so it stays hidden from your public
site.
The /projects/ page comes from the routes.yaml file that ships with the theme. If you have not uploaded it yet, follow the Getting Started guide, otherwise the page returns a 404.
What a Project Card Shows#
| Field | Where it comes from |
|---|---|
| Image | The post's feature image |
| Title | The post title |
| Label under the title | The first public tag on the post |
| Summary | The Excerpt field, or the start of the post when that is empty |
| List at the bottom | Every public tag after the first one |
Because the first public tag becomes the label and the rest become the list, tag order matters. Put the kind of work first, such as Data, Investigation or Tool, and the topics after it.
A project without a feature image shows the first letter of its title in place of the picture. The image carries the same badges as other cards. Video and Audio mark #video and #audio posts, and Members or Paid marks a post the reader cannot open yet.
The Projects Page#
The page opens with a Projects heading and the line Things we are building, shipping and maintaining. Below it, the project cards are listed newest first, 12 per page. The rest load behind a Load More button. With pagination in Disabled features, the page shows newer and older links instead. See Features.
Add the page to ⛭ Settings → Navigation with the URL /projects/ so readers can find it.
The Projects Block in the Menu#
A dropdown of the top navigation can show your four newest projects as small cards, under a caption with a View All link to the page. To add it:
- Navigate to ⛭ Settings → Navigation
- In the primary navigation, add a regular item that opens the dropdown, for example
Workwith the URL/projects/ - Directly under it, add an item whose label starts with
@, for example@ Projects, with the URL/projects/ - Click Save
The URL /projects/ is what picks the projects block. The label after @ becomes the caption. In the menu panel that opens from the menu button, the row is a plain link to the page. See Navigation for the rest of the dropdown rules.
Notes#
- A project post is still a post. It keeps its own URL and appears on the front page, in
/blog/, on its tag and author archives, and it can be sent as an email. - Project cards have no bookmark button. Readers can still bookmark the project from the post page. See Bookmarks.