@trilogy-ds/styles 0.0.1-beta.5 → 0.0.1-beta.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,47 @@
1
+ <div align='center'>
2
+
3
+ # @trilogy-ds/styles
4
+
5
+ </div>
6
+
7
+ [![npm](https://img.shields.io/npm/v/@trilogy-ds/styles?style=for-the-badge&logo=npm&logoColor=white&color=D44A4A)](https://www.npmjs.com/package/@trilogy-ds/styles)
8
+
9
+ ---
10
+
11
+ `@trilogy-ds/styles` is a direct dependency of [@trilogy-ds/react](https://www.npmjs.com/package/@trilogy-ds/react).
12
+
13
+ This package is a vital part of [Trilogy's design system](https://github.com/BouyguesTelecom/trilogy). Written in [SASS](https://sass-lang.com/). It provides a collection of SCSS styles used in Trilogy ( web only ). With a built-in framework for style definitions, and default themes, the package sets the foundation for stylizing Trilogy's components.
14
+
15
+ ---
16
+
17
+ ## CDN
18
+
19
+ For a faster setup, you can utilize the JSDelivr CDN to include Trilogy Design System's CSS directly in your project's HTML:
20
+
21
+ ```html
22
+ <!-- ... -->
23
+ <link href="https://cdn.jsdelivr.net/npm/@trilogy-ds/styles" rel="stylesheet" />
24
+ <!-- ... -->
25
+ ```
26
+
27
+ ## Structure
28
+
29
+ ```
30
+ .
31
+ ├── assets # Icons ( web )
32
+ ├── config # Plugins / Theme
33
+ ├── framework # SCSS Framework
34
+ ├── scripts # Scripts autolayout , spacing
35
+ ├── themes # Themes default
36
+ ```
37
+ ## Features
38
+
39
+ In addition to our minified CSS file, we also provide a mangled CSS version.
40
+
41
+ To use the mangled version:
42
+
43
+ ```html
44
+ <!-- ... -->
45
+ <link href="https://cdn.jsdelivr.net/npm/@trilogy-ds/styles/dist/default/trilogy-mangled.css" rel="stylesheet" />
46
+ <!-- ... -->
47
+ ```