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
+20-12Lines changed: 20 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,20 @@
4
4
5
5
## What is it?
6
6
7
-
A simple but nice header image generator for your Github profile Readme. [Website Link](https://leviarista.github.io/github-profile-header-generator/).
7
+
A simple but nice header image generator for your Github profile Readme.
8
+
You can use it for your repo banners too!
9
+
10
+
[Create my banner!](https://leviarista.github.io/github-profile-header-generator/)
8
11
9
12
## How to use it?
10
-
1. Create a nice github header image.
13
+
14
+
1. Create a nice github header image.
11
15
2. Create your GitHub profile README following [this guide](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme).
12
16
3. Upload your header to your profile repo.
13
-
4. Add this line to your README:
14
-
````Markdown
15
-

16
-
````
17
+
4. Add this line to your README:
18
+
```Markdown
19
+

20
+
```
17
21
18
22
## Examples
19
23
@@ -34,23 +38,27 @@ A simple but nice header image generator for your Github profile Readme. [Websit
34
38
- Set background pattern image, its color, size and opacity.
35
39
- Add decorations.
36
40
- Upload your own decoration, octocat or profile pic.
37
-
- Toogle Github dark and light mode.
41
+
- Toogle between Github dark and light mode.
38
42
- Download image as png.
39
-
- Randomize between predefined themes.
43
+
-Choose from predefined presets or get a random one.
40
44
41
45
## Tech used
42
46
43
47
-[Vite](https://vitejs.dev/)
44
-
- [html2canvas](https://html2canvas.hertzen.com/)
48
+
-[snapdom](https://zumerlab.github.io/snapdom/)
45
49
46
50
## Get started
47
51
48
-
- `npm run dev`- starts dev server
49
-
- `npm run build` - builds for production
50
-
- `npm run preview` - locally previews production build
52
+
-`npm run dev`- starts dev server
53
+
-`npm run build` - builds for production
54
+
-`npm run preview` - locally previews production build
51
55
52
56
## Get started with Docker
53
57
54
58
```bash
55
59
docker-compose up -d --build --force-recreate
56
60
```
61
+
62
+
## Contributing
63
+
64
+
Check out our [Contributing guide](https://github.com/leviarista/github-profile-header-generator/blob/main/.github/CONTRIBUTING.md)
0 commit comments