Skip to content
Start a project

Style guide · Security · Open source

Briar Style Guide

Public design system for Briar, the secure messaging app. Includes visual guidelines, brand assets, and components for contributors.

Visit site (briarproject.org)
Year
2019
Type
Style guide, Security, Open source
Stack
GitLab Pages, Hugo
Live site
briarproject.org
Briar Style Guide, the live site on a device

About the project

Briar is a secure messaging app built by a small team and volunteer contributors. Its style guide is a public website that documents how Briar looks: colours, type, icons and interface components.

Contributors work on the Android app, the desktop app, the website and printed material. Without a shared reference, each of them makes slightly different choices. We built the guide with Hugo on GitLab Pages and based its structure on the SecureDrop style guide, which made it quicker to build and familiar to navigate.

What we did

  • Public style guide in Hugo
  • Colour, spacing and typography documentation
  • Component examples with code
  • Light and dark themes
  • Publishing through GitLab Pages

Case study

Challenge

Briar’s contributors needed a shared visual reference for the messaging app across platforms and project materials.

Solution

We created a public guide to colors, typography, icons and interface components, drawing on the SecureDrop style guide structure.

Results

Contributors have a public reference for colors, typography, icons and interface components across Briar’s materials.

Screens

Briar Style Guide, the live site
Desktop capture, 1440 px
Briar Style Guide, mobile screen
Phone capture, 390 px

In detail

  • Colours with their contrast results

    Each palette is shown in every shade with its hex value and whether it passes WCAG AA for normal and for large text. A contributor picks a combination that is readable without running a checker.

  • Components you can copy

    Alerts, buttons and forms are shown as they render, with the code beside them and short rules for the wording. The guide can be used as a starting point, not only read as a description.

  • Public on purpose

    A volunteer cannot open a private design file. A public page can be linked in a code review, and assets such as the chat illustrations download as PNG or SVG straight from the guide.

How it is built

HugoStatic site generator
A static site generator. Pages are built once as plain HTML, so there is no database to attack or slow down, and the whole site builds in seconds.
GitLab PagesHosting
Static hosting built by GitLab's pipeline: each merge is built, checked and published from the same repository.

Lighthouse scores

Performance
96
Accessibility
72
Best practices
100
SEO
82

Lighthouse desktop scores, measured on the live sites.

Written about this project

Start with a price, then a conversation.

Build an estimate in a couple of minutes, or tell us what you need and we will outline the work, price and schedule.