La version française suit.
CSS Shortcuts
CSS Shortcuts is a CSS utility framework built to match GC Design System (GCDS) styles and Canada.ca standards. It provides predefined CSS utility classes that apply core design elements, like colours, spacing, and typography, to your HTML. The classes align with our GCDS design tokens for consistency and ease of use.
Documentation
You can find the full documentation on the GC Design System CSS Shortcuts at https://design-system.alpha.canada.ca/en/css-shortcuts/.
Installation
How to install using NPM
- Create a new project or go to the root folder of your existing project.
- Run
npm install @gcds-core/css-shortcuts to install the GC Design System CSS Shortcuts package.
How to install using CDN
Add the code
Use the latest version of GC Design System CSS Shortcuts. Pinned versions provide stability and predictability because the code will remain consistent and won't change unexpectedly, which can be crucial for maintaining the stability of an application. However, it requires manual updating of the CDN links whenever a newer version of GC Design System CSS Shortcuts is released.
Place the following code in the <head> element of your site. Replace <version-number> with the latest version number to receive corresponding updates.
<!-- GC Design System CSS Shortcuts -->
<link rel="stylesheet" href="https://cdn.design-system.alpha.canada.ca/@gcds-core/css-shortcuts@<version-number>/dist/gcds-css-shortcuts.min.css">
Automatic updates using @latest
Use the @latest version of GC Design System CSS Shortcuts to receive automatic updates whenever a new version is released. While it removes the need to manually update the CDN links, it adds the risk of introducing breaking changes to the codebase as new versions are automatically applied.
Local installation
- Clone the repo
git clone https://github.com/cds-snc/gcds-css-shortcuts.
- 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 CSS Shortcuts, please read our contributing guidelines.
License
Code released under the MIT License.
--------------------------------------------------------
Raccourcis CSS
Raccourcis CSS est un cadre utilitaire créé afin de s'aligner avec les styles du SystÚme de design GC et les normes de Canada.ca. Il donne accÚs à des classes utilitaires CSS prédéfinies qui appliquent des éléments de design de base tels les couleurs, l'espacement et la typographie à votre code HTML. Les classes s'alignent avec nos unités de style afin d'assurer une uniformité et une facilité d'utilisation.
Documentation
Toute la documentation sur l'utilitaire de SystĂšme de design GC est accessible Ă l'adresse https://design-system.alpha.canada.ca/fr/raccourcis-css/.
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 @gcds-core/css-shortcuts pour installer le progiciel de Raccourcis CSS du SystĂšme de design GC.
Installation Ă l'aide de CDN
Ajoutez le code
Utilisez la version la plus rĂ©cente de Raccourcis CSS du SystĂšme de design GC. Les versions Ă©pinglĂ©es offrent stabilitĂ© et prĂ©visibilitĂ© parce que le code ne changera pas de maniĂšre inattendue, ce qui peut ĂȘtre crucial pour maintenir la stabilitĂ© d'une application. Toutefois, il faut mettre Ă jour manuellement les liens CDN chaque fois qu'une version plus rĂ©cente de Raccourcis CSS du SystĂšme de design GC est publiĂ©e.
Insérez le code qui suit à l'intérieur de la balise <head> de votre site. Remplacez <version-number> par le numéro de version le plus récent pour recevoir les mises à jour correspondantes.
<!-- SystĂšme de design GC Raccourcis CSS -->
<link rel="stylesheet" href="https://cdn.design-system.alpha.canada.ca/@gcds-core/css-shortcuts@<version-number>/dist/gcds-css-shortcuts.min.css">
Mises Ă jour automatiques grĂące Ă @latest
Utilisez la version @latest de Raccourcis CSS du SystÚme de design GC pour recevoir des mises à jour automatiques chaque fois qu'une nouvelle version est publiée. Bien que cette approche vous évite la mise à jour manuelle des liens CDN, elle court le risque d'introduire des modifications qui entraßnent une rupture de compatibilité avec le code base à mesure que les nouvelles versions sont automatiquement appliquées.
Installation locale
- Copiez le référentiel
git clone https://github.com/cds-snc/gcds-css-shortcuts.
- 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 Raccourcis CSS du SystĂšme de design GC, veuillez lire nos lignes directrices sur la contribution.
Licence
Code publié en vertu de la licence MIT (en anglais).