mirror of
https://github.com/dilllxd/gitfolio.git
synced 2024-08-14 22:28:09 +00:00
Update README.md
This commit is contained in:
parent
0b505ce7c6
commit
39f9053456
1 changed files with 30 additions and 0 deletions
30
README.md
30
README.md
|
@ -1,2 +1,32 @@
|
||||||
# gitfolio
|
# gitfolio
|
||||||
portfolio website that showcases your work
|
portfolio website that showcases your work
|
||||||
|
|
||||||
|
# Getting Started
|
||||||
|
|
||||||
|
First of all you need to fork this repo as "your_username.github.io"
|
||||||
|
|
||||||
|
```
|
||||||
|
$ git clone "your repo you just forked"
|
||||||
|
$ cd "your repo name"
|
||||||
|
$ npm i
|
||||||
|
```
|
||||||
|
|
||||||
|
# Building
|
||||||
|
|
||||||
|
```
|
||||||
|
$ node build --name "your_username"
|
||||||
|
```
|
||||||
|
|
||||||
|
# Customizing
|
||||||
|
|
||||||
|
To add your background image
|
||||||
|
|
||||||
|
```
|
||||||
|
$ node build --name "your github username" --background "background url"
|
||||||
|
```
|
||||||
|
|
||||||
|
To enable Dark theme
|
||||||
|
|
||||||
|
```
|
||||||
|
$ node build --name "your github username" --dark
|
||||||
|
```
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue