Skip to content

Commit d3c2e5e

Browse files
authored
Merge pull request #1 from MathisBurger/dev
adding documentation
2 parents 0f41f7e + 2f4710d commit d3c2e5e

File tree

7 files changed

+67
-10
lines changed

7 files changed

+67
-10
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
main.css.map
22
main.css
3+
chocolate.min.css
4+
chocolate.css
5+
index.html

.media/btn-blue.PNG

2.59 KB
Loading

.media/btn-default-shadow.PNG

2.71 KB
Loading

.media/btn-shadow-lg.PNG

5.42 KB
Loading

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,21 @@ ChocolateCSS is an lightweight scss libary, I build for use
1616
in my personal projects. I wanted to learn more about professional web design. Furthermore I my intention behind this project was, to get rid of css boilerplate code.<br>
1717
ChocolateCSS is not made for beginners. It is especially made for people, who want to design their web pages or apps very fast. But you need at least a bit of css experience.
1818

19+
<strong>NOTE:</strong> This libary is made for the development of dark themes. It is quite hard to build light themes with it.
20+
1921
# Installation
2022

2123
---
2224
Latest release:
23-
<a href="">Download</a>
25+
<a href="https://github.com/MathisBurger/ChocolateCSS/releases/download/v1.0.0-beta/">Download</a>
2426
```css
25-
@import url("https://github.com/MathisBurger/ChocolateCSS");
27+
@import url("https://github.com/MathisBurger/ChocolateCSS/releases/download/v1.0.0-beta/chocolate.min.css");
2628
```
2729

2830
# Documentation
2931

3032
---
31-
- Buttons
33+
- <a href="documentation/buttons.md">Buttons</a>
3234
- Flex
3335
- Nav
3436
- Scripts

documentation/buttons.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Button documentation
2+
3+
This part of the documentation will show you, how to use<br>
4+
the buttons of ChocolateCSS.
5+
6+
### Buttons and colors
7+
8+
To use buttons with ChocolateCSS is quite easy.
9+
10+
```html
11+
<button class="btn-blue">Button Text</button>
12+
```
13+
14+
The final result will look like this:
15+
<div align="center"><img src="../.media/btn-blue.PNG"></div>
16+
17+
`btn-` is the base of the button classes. If you want to use other colors then blue, you need to change `blue` to another
18+
color. For example: `btn-red`.
19+
20+
Supported colors:
21+
- blue
22+
- red
23+
- green
24+
- purple
25+
- pink
26+
27+
### Button sizes
28+
29+
Furthermore you can change the size of the different buttons with the extra size classes.
30+
```html
31+
<button class="btn-blue btn-lg">Button Text</button>
32+
```
33+
34+
The extra class `btn-lg` will increase the size of the button.
35+
You can also use `btn-sm` to reduce the size.
36+
The default value of the button is `btn-md`.
37+
38+
39+
### Button shadows
40+
41+
If the `box-shadow` if the button does not match your taste,
42+
you can also change it.
43+
44+
```html
45+
<button class="btn-blue btn-shadow-lg">Button Text</button>
46+
```
47+
48+
The extra class `btn-shadow-lg` increases the shadow.
49+
You can also use `btn-shadow-md` and `btn-shadow-sm`.
50+
Default value is `btn-shadow-sm`.
51+
52+
<div align="center">
53+
<img src="../.media/btn-default-shadow.PNG">
54+
<img src="../.media/btn-shadow-lg.PNG">
55+
</div>
56+
57+
The left button shows the default shadow. The right one contains the extra class `btn-shadow-lg`.
58+

index.html

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,7 @@
88

99
<body style="background: #161616;">
1010

11-
<div class="container-lg">
12-
<div class="row-lg">
13-
<div style="width: 700px; background: blue; height: 3em;"></div>
14-
<div style="width: 500px; background: red; height: 3em;"></div>
15-
<div style="width: 300px; background: green; height: 3em;"></div>
16-
</div>
17-
</div>
11+
<button class="btn-blue btn-shadow-lg">Button Text</button>
1812

1913
</body>
2014
</html>

0 commit comments

Comments
 (0)