@cdssnc/gcds-utility
v1.5.0
Published
GC Design System Utility
Downloads
345
Keywords
Readme
GC Design System Utility
GC Design System Utility is a utility framework for the GC Design System core. It is based on functional CSS (also called atomic CSS or utility-first CSS) that favors small, single-purpose classes with names based on their visual function. These classes are easy to understand, reusable and can be used together to build complex layouts.
Documentation
You can find the full documentation for GC Design System Utility on https://design-system.alpha.canada.ca/.
Installation
How to install using NPM
- Create a new project or go to the root folder of your existing project.
- Run
npm install @cdssnc/gcds-utility
to install the GC Design System Utility package.
How to install using CDN
Place the following code in the <head>
element of your site.
<!-- GC Design System Utility -->
<link rel="stylesheet" href="https://cdn.design-system.alpha.canada.ca/@cdssnc/gcds-utility@latest/dist/gcds-utility.min.css">
Local installation
- Clone the repo
git clone https://github.com/cds-snc/gcds-utility
. - Run
npm install
to install all Node.js dependencies. - Run
gulp
to monitor your source files for any changes. - Run
gulp compile
to compile and minify all CSS files.
How to contribute
If you are interested in contributing to GC Design System Utility, please read our contributing guidelines.
License
Code released under the MIT License.
--------------------------------------------------------
Utilitaire de Système de design GC
L'utilitaire de Système de design GC est un cadre utilitaire pour la base de ce système. Cet utilitaire est fondé sur un code CSS fonctionnel (aussi appelé « atomic CSS » ou encore « utility-first CSS ») qui privilégie de petites classes à but unique nommées selon leur fonction visuelle. Ces classes sont réutilisables et faciles à comprendre. De plus, elles peuvent être combinées pour créer des structures complexes.
Documentation
Toute la documentation sur l'utilitaire de Système de design GC est accessible à l'adresse https://systeme-design.alpha.canada.ca/.
Installation
Installation à l'aide de NPM
- Créez un nouveau projet ou naviguez vers le dossier racine de votre projet existant.
- Exécutez
npm install @cdssnc/gcds-utility
pour installer le progiciel de l'utilitaire de Système de design GC.
Installation à l'aide de CDN
Inscrivez le code suivant dans l'élément <head>
de votre site Web :
<!-- GC Design System Utility -->
<link rel="stylesheet" href="https://cdn.design-system.alpha.canada.ca/@cdssnc/gcds-utility@latest/dist/gcds-utility.min.css">
Installation locale
- Copiez le référentiel
git clone https://github.com/cds-snc/gcds-utility
. - Exécutez ensuite
npm install
pour installer toutes les dépendances Node.js. - Puis, exécutez
gulp
pour surveiller tout changement survenant dans vos fichiers sources. - Finalement, exécutez
gulp compile
pour compiler et minifier tous les fichiers CSS.
Apportez votre contribution
Si vous souhaitez contribuer aux unités de style de Système de design GC, veuillez lire nos lignes directrices sur la contribution.
Licence
Code publié en vertu de la licence MIT (en anglais).