このプロジェクトについて
Primer CSSは、GitHubのPrimer Design SystemをCSSで実装したもので、npm上で`@primer/css`として公開されています。これはPrimerのスタイリングレイヤーを提供し、チームがインターフェースの視覚的な一貫性を維持するために再利用できるユーティリティクラスとコンポーネントスタイルを提供します。
含まれる内容
- SCSS構文で記述されたSassソース。全体またはモジュール単位でインポート可能です。
- `core`、`product`、`marketing`という異なるコンテキスト向けの個別のエントリポイントがあり、プロジェクトに必要なスタイリングのみを取り込むことができます。
- ドキュメント化されたテーマとコンポーネントセット。プロジェクトのドキュメントサイト(primer.style/css)で、導入方法、コンポーネント、テーマ設定、デザイン原則について説明されています。
インストールと使用方法
npmをインストールした後、`npm install --save @primer/css`でプロジェクトに追加できます。ソースがSCSSであるため、プロジェクトの`node_modules`ディレクトリをSassのインクルード(ロード)パスに含める必要があります。そこから、`@import "@primer/css/index.scss";`で完全なスタイルシートをインポートするか、`@import "@primer/css/core/index.scss";`、`@import "@primer/css/product/index.scss";`、`@import "@primer/css/marketing/index.scss";`のように個別のモジュールを直接インポートできます。
プロジェクトのステータス
READMEの警告にある通り、このリポジトリはKTLO("keep the lights on")モードにあります。指針としては、必要な箇所で既存のユーティリティクラスを引き続き使用することですが、スタイリングとマークアップを組み合わせたより完全なパターンについては、primer/react、または必要に応じてprimer/view_componentsへの移行が推奨されています。言い換えれば、Primer CSSはユーティリティクラスについて利用可能でサポートされ続けますが、新しいパターンの開発はReactおよびViewComponentsの実装へと誘導されています。
開発と貢献
リポジトリには開発ドキュメントであるDEVELOP.mdと、GitHubスタッフ向けのリリースプロセスをカバーするRELEASING.mdが含まれています。継続的インテグレーションはGitHub Actionsを通じて実行され、リリースメタデータはnpmおよびGitHubバッジ(パッケージバージョン、ビルドステータス、貢献者、最終コミット、ライセンス)を通じて公開されています。
ライセンス
このプロジェクトはMITライセンスの下でリリースされており、著作権はGitHubに帰属します。
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.