+0
Daily
300
stars
84
forks
28
watchers
639
prs
553
issues
60
releases
README
Mozilla Protocol Protocol is a design system for Mozilla and Firefox websites. It establishes a common design language, provides reusable coded components, and outlines high level guidelines for content and accessibility. https://protocol.mozilla.org/ Protocol is still an evolving project. Currently, it’s used primarily by the Mozilla Marketing Websites team as the front-end for www.mozilla.org. The long term goal is to provide a robust, unified design system that anyone at Mozilla can use to build an on-brand website. If you’re interested in using Protocol on your project, let us know and we can help you. You can find us in protocol-design-system on Mozilla’s Slack (for Mozillians) or in protocol-design-system on Matrix (open to the public). Also feel free to file an issue on GitHub. Getting Started Protocol is built on the Node.js platform and published to NPM, so be sure to have both installed before proceeding. Installation To use Protocol in your website you can install the core package directly from NPM: npm install @mozilla-protocol/core --save Alternatively, you can also download the latest release from GitHub. Usage Once installed, the relevant CSS, JavaScript, and asset files will be available in your project under ./node_modules/@mozilla-protocol/core/. The core CSS file is bundled as protocol.css, which contains styling for things such as basic elements and typography, as well as some global components like navigation and a footer. Other component and layout CSS is bundled as protocol-components.css for convenience. However, these pre-compiled CSS files include the _entire_ pattern library, which you may not need. We recommend compiling your own styles from the source Sass files, also included in the published package. That allows you to configure Protocol to include just the styles and components you need for each page of your website. Make it Run To build Protocol from source and run the documentation site locally, you can clone the repo from GitHub: $ git clone https://github.com/mozilla/protocol.git $ cd protocol $ npm install Running npm install will install dependencies. Then: $ npm run webpack This will compile the Sass and copy assets into a local folder in preparation to run the server. It also starts a “watch” process that will watch those files and automatically recompile when they change. In another command line console (and still within the Protocol folder), run: $ npm start This will build the site locally and start the development server at . Building the website To build the Protocol documentation site for deployment, run: $ npm run build-docs Building the NPM package We use a Webpack configuration for building the contents of the NPM package ready for publishing. To build the package, run: npm run build-package This will install dependencies, lint CSS/JS files, and then build the package content in the ./package/ directory. Running tests To perform the package bui
Top issues
#201Document image sizes for components13 comments · 2018-08-07#848Component Change Request: use AAA contrast standards on Error notification bar9 comments · 2023-02-03#732Add file paths to protocol documentation6 comments · 2021-10-12#1086Update Mozila Typeface web fonts5 comments · 2025-08-13#200Standardize template spacing5 comments · 2018-08-07#855Update Modal Style4 comments · 2023-02-24#376Improve Protocol's getting started documentation4 comments · 2019-04-24#909Want to add relative color hover effect on the footer social icons3 comments · 2023-12-13
Latest release
v21.0.0 v21.0.0 2025-05-02Features assets: (breaking) Update @mozilla-protocol/assets to 6.0.1 css: Update navigation and footer with Mozilla logo lockup. Bug Fixes css: Notification bar padding of links only working for complete sentences (1000) css: Missing explicit mzp-c-notification-bar-cta distinction (1041) css: Fix logo size in navigation in Firefox variant on large screen Migration Tips The new Mozilla wordmark files are the same height but longer. If you are explicitly declaring a width for them, you should update it (Tip: check your CSS background images too.) The flat logo files a