css README

The project's README from github.com/primer/css. As one markdown file: README.md.

Primer CSS

The CSS implementation of GitHub's Primer Design System

npm package build status contributors graph last commit license

:warning: This project is in KTLO mode! Use existing utility classes from this project where needed. For more complete patterns that include styling and markup, please use primer/react or, if necessary, primer/view_components.

Documentation

Our documentation site lives at primer.style/css. You'll be able to find detailed documentation on getting started, all of the components, our theme, our principles, and more.

Install

This repository is distributed with npm. After installing npm, you can install @primer/css with this command:

npm install --save @primer/css

Usage

The included source files are written in Sass using SCSS syntax. Once installed, you can add your project's node_modules directory to your Sass include paths (AKA load paths in Ruby), then import it like this:

@import "@primer/css/index.scss";

You can import individual Primer modules directly from the @primer/css package:

@import "@primer/css/core/index.scss";
@import "@primer/css/product/index.scss";
@import "@primer/css/marketing/index.scss";

Development

See DEVELOP.md for development docs.

Releasing (for GitHub staff)

You can find docs about our release process in RELEASING.md.

License

MIT © GitHub

css (primer/css)

Searching Database…

13K ·GitHub
Что это такое?Primer CSS — это CSS-реализация дизайн-системы GitHub: open-source-пакет @primer/css, который стоит за внешним видом github.com.
Так это CSS-фреймворк, который я подключаю в свой проект, или что-то внутреннее у GitHub?Это CSS-фреймворк для любого веб-проекта: исходники на Sass в синтаксисе SCSS, которые вы ставите через npm и подключаете в своей сборке, а не инструмент только для GitHub.
Как добавить его в проект?Установите npm, выполните npm install @primer/css, а затем добавьте папку пакета из node_modules в include-пути Sass. Полная документация — на primer.style/css.
Что должно быть в моей сборке, чтобы всё работало?Node и npm (пакет рассчитан на Node 16+) плюс компилятор Sass в цепочке сборки, потому что Primer поставляется как исходники SCSS, а не готовый CSS.
Это по-прежнему рекомендуемый способ делать интерфейсы в стиле GitHub, или проект уже устарел?Он в режиме KTLO (keep-the-lights-on): только поддержка. Для готовых паттернов со стилями и разметкой используйте primer/react или primer/view_components; существующие utility-классы по-прежнему можно спокойно использовать.
Можно ли использовать его в коммерческих проектах?Да — лицензия MIT от GitHub, так что коммерческое использование не проблема.
Насколько это состоявшийся проект?Очень — GitHub развивает Primer в открытом виде с марта 2015 года, а у репозитория около 13 000 звёзд. Это дизайн-система, на которой работает сам GitHub.
А в этом репозитории есть и JavaScript-компоненты?Нет — это только CSS-слой: исходники Sass без рантайм-зависимостей. Готовые паттерны с разметкой и интерактивом живут в соседних пакетах Primer.
What are similar projects?mdb-ui-kit, daisyui, NES.css, yeti, weui, blueprint, tachyons, bootstrap
Creator
primer
Size
38.4 MB
Stars
13K
Age
11y
Commits · 90 Days