Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add package details to docs #977

Merged
merged 3 commits into from
Dec 10, 2024
Merged

Add package details to docs #977

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
beaf2fc
Add npm badge to docs
janbrasna Aug 6, 2024
7f97325
Update README badges & links
janbrasna Aug 6, 2024
8e534fd
Simplify homepage title
janbrasna Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,15 @@ Mozillians) or in #protocol-design-system on [Matrix](https://chat.mozilla.org/)
(open to the public). Also feel free to
[file an issue on GitHub](https://github.com/mozilla/protocol/issues).

![Current npm package version.](https://img.shields.io/npm/v/@mozilla-protocol/core)
![Total downloads on npm.](https://img.shields.io/npm/dt/@mozilla-protocol/core)
![Pull requests welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen)
[![Current npm package version.](https://img.shields.io/npm/v/@mozilla-protocol/core)](https://www.npmjs.com/package/@mozilla-protocol/core)
[![Total downloads on npm.](https://img.shields.io/npm/dt/@mozilla-protocol/core)](https://github.com/mozilla/protocol/releases)
[![Pull requests welcome!](https://img.shields.io/badge/PRs-welcome-93c?logo=github
)](https://protocol.mozilla.org/docs/contributing/overview)

## Getting Started

Protocol is built on the [Node.js](https://nodejs.org/) platform and published
to [NPM](https://www.npmjs.com/), so be sure to have both installed before
to [NPM](https://www.npmjs.com/package/@mozilla-protocol/core), so be sure to have both installed before
proceeding.

## Installation
Expand Down
2 changes: 2 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Mozilla Protocol
hidden: true
---

[![Current npm package version](https://img.shields.io/npm/v/@mozilla-protocol/core)](https://www.npmjs.com/package/@mozilla-protocol/core)

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.

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](https://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.
Expand Down
2 changes: 1 addition & 1 deletion theme/views/partials/head.nunj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<link rel="shortcut icon" href="{{ path(frctl.theme.get('favicon')) }}" type="image/png">
{% include 'partials/stylesheets.nunj' %}
<title>{% if page.title %}{{ page.title }} | {% endif %}{{ frctl.get('project.title') }}</title>
<title>{% if page.title and page.title !== frctl.get('project.title') %}{{ page.title }} | {% endif %}{{ frctl.get('project.title') }}</title>