You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+52-27Lines changed: 52 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,48 +12,73 @@ Our philosophy is mobile first, self explanatory code code and breakpoints. On t
12
12
### Breakpoint CSS
13
13
We don't believe in classes like *laptop* or *small* and other classes but we define everything with **b{breakpoint}** this makes everything readable and since we use this throughout the whole framework everything feels familiar when you use it for a while. Whether it's for grid, utility classes, hiding, showing. It all starts with **b{breakpoint}**
14
14
15
-
## Included files
15
+
### Breakpoints
16
+
Mobile first breakpoints (defined in variables.scss)
17
+
18
+
b0: 0px; (smartwatch and higher)
19
+
b1: 320px; (phone portait and higher)
20
+
b2: 480px; (phone landscape and higher)
21
+
b3: 768px; (tablet portait and higher)
22
+
b4: 1024px; (tablet landscape/desktop and higher)
23
+
b5: 1280px; (desktop large and higher)
24
+
b6: 1600px; (desktop huge and higher)
25
+
26
+
As your base you can always just use b0, only use b1 if you have a totally different markup <320px
27
+
28
+
## Included files and structure
16
29
CastleCSS Core has the following basic files to kickstart your website:
17
30
18
-
- main - *include all your other SCSS files*
19
-
- reset - *set browser defaults to zero/none so nothing weird happends in different browsers*
20
-
- variables - *Variables for the grid, fonts, utility, etc*
21
-
- grid - *Flexbox scss grid with floating fallback*
22
-
- defaults - *Set default web settings*
23
-
- mixins - *Small but handy collection of mixins to use*
Of course you want to be able to set your own variables and other classes. To do this: make your own custom folder outside of node modules folder and include the files in your main.scss.
26
60
27
61
## How to install
28
-
You can install castle css with NPM in your sass folder:
62
+
You can install castle css with [NPM](https://nodejs.org) in your sass folder:
29
63
30
-
npm i castlecss-core
31
-
64
+
npm i castlecss-core
65
+
32
66
### How to update
33
67
Type the following to check for updates in your sass folder:
34
-
35
-
npm outdated
36
-
68
+
69
+
npm outdated
70
+
37
71
38
72
Nothing? Good! Then you're up to date
39
73
In any other case you'll get something that looks like this:
40
74
41
-
Package Current Wanted Latest Location
42
-
castlecss-core 1.0.0 1.1.0 1.1.0 castlecss-core
75
+
Package Current Wanted Latest Location
76
+
castlecss-core 1.0.0 1.1.0 1.1.0 castlecss-core
43
77
44
78
So type the following to update:
45
79
46
-
npm update
80
+
npm update
47
81
48
82
If you didn't alter the core files it will now update.
49
83
If the updated did succeed you shouldn't get anything back from your terminal if you use *npm outdated* again
50
84
51
-
# SCSS folder structure and overwriting the CastleCSS defaults
52
-
Of course you want to be able to set your own variables and other classes. To do this: make your own custom folder outside of node modules and include the files. The ideal structure of your SASS folder should be the following:
53
-
54
-
| Your project
55
-
| -- sass/ //your custom scss goes here
56
-
| -- | main.scss //include your own SCSS files and /node_modules/castlecss-core/main.scss here
57
-
| -- | node_modules/ //CastleCSS files are automatically installed here
0 commit comments