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
+50-40Lines changed: 50 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,61 +12,71 @@ 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
-
#### Mobile first breakpoints (defined in variables.scss)
16
-
$b0: 0px; (smartwatch and higher)
17
-
$b1: 320px; (phone portait and higher)
18
-
$b2: 480px; (phone landscape and higher)
19
-
$b3: 768px; (tablet portait and higher)
20
-
$b4: 1024px; (tablet landscape/desktop and higher)
21
-
$b5: 1280px; (desktop large and higher)
22
-
$b6: 1600px; (desktop huge and higher)
23
-
24
-
Of course you can just add your own breakpoints if you want to.
25
-
26
-
## What's included
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
+
## Included files and structure
27
27
CastleCSS Core has the following basic files to kickstart your website:
28
28
29
-
30
-
main - include all your other SCSS files
31
-
reset - set browser defaults to zero/none so nothing weird happends in different browsers
32
-
variables - Variables for the grid, fonts, utility, etc
33
-
grid - Flexbox scss grid with floating fallback
34
-
defaults - Set default web settings
35
-
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.
38
58
39
59
## How to install
40
60
You can install castle css with NPM in your sass folder:
41
61
42
-
npm i castlecss-core
43
-
62
+
npm i castlecss-core
63
+
44
64
### How to update
45
65
Type the following to check for updates in your sass folder:
46
-
47
-
npm outdated
48
-
66
+
67
+
npm outdated
68
+
49
69
50
70
Nothing? Good! Then you're up to date
71
+
In any other case you'll get something that looks like this:
51
72
52
-
If you need to update you'll get something that looks like this:
53
-
54
-
Package Current Wanted Latest Location
55
-
castlecss-core 1.0.0 1.1.0 1.1.0 castlecss-core
73
+
Package Current Wanted Latest Location
74
+
castlecss-core 1.0.0 1.1.0 1.1.0 castlecss-core
56
75
57
76
So type the following to update:
58
77
59
-
npm update
78
+
npm update
60
79
61
80
If you didn't alter the core files it will now update.
62
81
If the updated did succeed you shouldn't get anything back from your terminal if you use *npm outdated* again
63
82
64
-
# SCSS folder structure and overwriting the CastleCSS defaults
65
-
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:
66
-
67
-
| Your project
68
-
| -- sass/ //your custom scss goes here
69
-
| -- | main.scss //include your own SCSS files and /node_modules/castlecss-core/main.scss here
70
-
| -- | node_modules/ //CastleCSS files are automatically installed here
0 commit comments