Pharos

<p align="center"> <img alt="Pharos Design System" src="./readme_header.png" width="100%" /> </p> <h1 align="center"> Pharos Design System </h1>

Pharos is JSTOR’s design system for creating cohesive, supportive and beautiful experiences for the intellectually curious.

JSTOR is a digital library for the intellectually curious. We provide a platform for discovering and connecting research, images, and primary sources. As a not-for-profit, we partner with libraries, museums, and publishers to reduce costs, extend access, and preserve scholarship for the future. We do this because we believe in the power of knowledge to change the world for the better.

<p align="center"> <a href=".github/CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a> <a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Pharos is released under the MIT license" /></a> <a href="#contributors-"><img src="https://img.shields.io/github/all-contributors/ithaka/pharos?color=orange" alt="All Contributors" /></a> <a href="https://bundlephobia.com/package/@ithaka/pharos"><img src="https://img.shields.io/bundlephobia/min/@ithaka/pharos" alt="Bundlephobia stats" /></a> </p>

Build statuses

| System | Status | | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Site | | | Storybooks | |

Getting Started

• Check out the core package for more info about Pharos components and how to get started
• Visit the Pharos site to learn about the JSTOR brand, design guidelines, and component usage guidelines
• Explore the web component Storybook or the React Storybook to try the live components
• Test for visual regressions in the Pharos Chromatic project

Packages and configuration

This repository contains a number of packages related to Pharos:

| Syntax | Description | | --------------------------------------------- | --------------------------------------- | | @ithaka/pharos | Pharos Component library | | @ithaka/pharos-cli | CLI tool for building Pharos components | | @ithaka/pharos-site | Site & Documentation for Pharos |

In addition to these packages, this repository contains the configuration for Pharos Storybooks.

Contributing

If you'd like to learn more about contributing to Pharos, refer to the contribution guide.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://niznikr.github.io/"><img src="https://avatars.githubusercontent.com/u/2147624?v=4?s=100" width="100px;" alt="Robert Niznik"/><br />_{<b>Robert Niznik</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=Niznikr" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/SMQuazi"><img src="https://avatars.githubusercontent.com/u/7356353?v=4?s=100" width="100px;" alt="Sayem Quazi"/><br />_{<b>Sayem Quazi</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=SMQuazi" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://dane.engineering/"><img src="https://avatars.githubusercontent.com/u/1808306?v=4?s=100" width="100px;" alt="Dane Hillard"/><br />_{<b>Dane Hillard</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=daneah" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/jbhakta"><img src="https://avatars.githubusercontent.com/u/4246209?v=4?s=100" width="100px;" alt="Jayshree Bhakta"/><br />_{<b>Jayshree Bhakta</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=jbhakta" title="Tests">⚠️</a></td> <td align="center" valign="top" width="14.28%"><a href="https://evanslawski.com/"><img src="https://avatars.githubusercontent.com/u/3267412?v=4?s=100" width="100px;" alt="Evan Slawski"/><br />_{<b>Evan Slawski</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=eslawski" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/kelseytrabue"><img src="https://avatars.githubusercontent.com/u/1484014?v=4?s=100" width="100px;" alt="Kelsey Cavitt"/><br />_{<b>Kelsey Cavitt</b>}</a><br /><a href="#design-kelseytrabue" title="Design">🎨</a> <a href="https://github.com/ithaka/pharos/commits?author=kelseytrabue" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/jialin-he"><img src="https://avatars.githubusercontent.com/u/38861633?v=4?s=100" width="100px;" alt="Jialin He"/><br />_{<b>Jialin He</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=jialin-he" title="Code">💻</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/michael-iden"><img src="https://avatars.githubusercontent.com/u/13315416?v=4?s=100" width="100px;" alt="Mike Iden"/><br />_{<b>Mike Iden</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=michael-iden" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ymouzakis"><img src="https://avatars.githubusercontent.com/u/64924035?v=4?s=100" width="100px;" alt="Yanni Mouzakis"/><br />_{<b>Yanni Mouzakis</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=ymouzakis" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/kentjas1"><img src="https://avatars.githubusercontent.com/u/2760087?v=4?s=100" width="100px;" alt="Jay Kent"/><br />_{<b>Jay Kent</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=kentjas1" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/seanggani"><img src="https://avatars.githubusercontent.com/u/60366518?v=4?s=100" width="100px;" alt="Sean Anggani"/><br />_{<b>Sean Anggani</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=seanggani" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/rehanabbasi"><img src="https://avatars.githubusercontent.com/u/23479616?v=4?s=100" width="100px;" alt="Rehan Abbasi"/><br />_{<b>Rehan Abbasi</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=rehanabbasi" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/seanmitchey"><img src="https://avatars.githubusercontent.com/u/3036959?v=4?s=100" width="100px;" alt="Sean Mitchey"/><br />_{<b>Sean Mitchey</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=seanmitchey" title="Tests">⚠️</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/cameronheard"><img src="https://avatars.githubusercontent.com/u/3027683?v=4?s=100" width="100px;" alt="Cameron Heard"/><br />_{<b>Cameron Heard</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=cameronheard" title="Tests">⚠️</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/aebankston"><img src="https://avatars.githubusercontent.com/u/4641137?v=4?s=100" width="100px;" alt="Aparna Bankston"/><br />_{<b>Aparna Bankston</b>}</a><br /><a href="https://github.com/ithaka/pharos/commits?author=aebankston" title="Tests">⚠️</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Liza-Pagano"><img src="https://avatars.githubusercontent.com/u/64424406?v=4?s=100" width="100px;" alt="Liza-Pagano"/><br />_{<b>Liza-Pagano</b>}</a><br /><a href="#design-Liza-Pagano" title="Design">🎨</a> <a href="https://github.com/ithaka/pharos/commits?author=Liza-Pagano" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/lorilundy711"><img src="https://avatars.githubusercontent.com/u/80061918?v=4?s=100" width="100px;" alt="Lori Lundy"/><br />_{<b>Lori Lundy</b>}</a><br /><a href="#design-lorilundy711" title="Design">🎨</a> <a href="https://github.com/ithaka/pharos/commits?author=lorilundy711" title="Documentation">📖</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/fswlee"><img src="https://avatars.githubusercontent.com/u/5896534?v=4?s=100" width="100px;" alt="Florence Lee"/><br />_{<b>Florence Lee</b>}</a><br /><a href="#design-fswlee" title="Design">🎨</a> <a href="https://github.com/ithaka/pharos/commits?a