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.
You can find the full documentation for GC Design System Utility on https://design-system.alpha.canada.ca/.
- Create a new project or go to the root folder of your existing project.
- Run
npm install @cdssnc/gcds-utilityto install the GC Design System Utility package.
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">
- Clone the repo
git clone https://github.com/cds-snc/gcds-utility. - Run
npm installto install all Node.js dependencies. - Run
gulpto monitor your source files for any changes. - Run
gulp compileto compile and minify all CSS files.
If you are interested in contributing to GC Design System Utility, please read our contributing guidelines.
Code released under the MIT License.
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.
Toute la documentation sur l'utilitaire de Système de design GC est accessible à l'adresse https://systeme-design.alpha.canada.ca/.
- Créez un nouveau projet ou naviguez vers le dossier racine de votre projet existant.
- Exécutez
npm install @cdssnc/gcds-utilitypour installer le progiciel de l'utilitaire de Système de design GC.
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">
- Copiez le référentiel
git clone https://github.com/cds-snc/gcds-utility. - Exécutez ensuite
npm installpour installer toutes les dépendances Node.js. - Puis, exécutez
gulppour surveiller tout changement survenant dans vos fichiers sources. - Finalement, exécutez
gulp compilepour compiler et minifier tous les fichiers CSS.
Si vous souhaitez contribuer aux unités de style de Système de design GC, veuillez lire nos lignes directrices sur la contribution.
Code publié en vertu de la licence MIT (en anglais).