1
0
Fork 0
mirror of https://github.com/dilllxd/gitfolio.git synced 2024-08-14 22:28:09 +00:00
gitfolio/README.md

146 lines
4.7 KiB
Markdown
Raw Normal View History

<img src="https://i.imgur.com/eA6clZr.png">
2019-05-24 15:40:18 +00:00
# Gitfolio [![Tweet](https://img.shields.io/twitter/url/https/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=personal%20website%20and%20a%20blog%20for%20every%20github%20user%20&url=https://github.com/imfunniee/gitfolio) ![GitHub release](https://img.shields.io/github/release/imfunniee/gitfolio.svg?style=popout-square) ![npm](https://img.shields.io/npm/dm/gitfolio.svg?style=popout-square) ![GitHub top language](https://img.shields.io/github/languages/top/imfunniee/gitfolio.svg?style=popout-square) ![GitHub last commit](https://img.shields.io/github/last-commit/imfunniee/gitfolio.svg?style=popout-square) ![GitHub](https://img.shields.io/github/license/imfunniee/gitfolio.svg?style=popout-square)
### personal website + blog for every github user
2019-05-20 09:39:36 +00:00
Gitfolio will help you get started with a portfolio website where you could showcase your work + a blog that will help you spread your ideas into real world.
Check out this [live demo](https://imfunniee.github.io/gitfolio/) to see gitfolio in action.
2019-05-20 09:39:36 +00:00
# Getting Started
### Let's Install
Install gitfolio
```sh
2019-05-23 10:00:03 +00:00
npm i gitfolio -g
```
### Let's Build
```sh
gitfolio build <username>
```
2019-05-23 10:04:22 +00:00
`<username>` is your username on github. This will build your website using your GitHub username and put it in the `/dist` folder.
2019-05-26 13:13:15 +00:00
To run your website use `run` command
```sh
2019-05-23 10:09:12 +00:00
gitfolio run
```
🎉 Congrats, you just made yourself a personal website!
### Let's Customize
2019-05-20 09:39:36 +00:00
#### Forks
To include forks on your personal website just provide `-f` or `--fork` argument while building
2019-05-23 10:03:37 +00:00
```sh
$ gitfolio build <username> -f
2019-05-20 09:39:36 +00:00
```
#### Sorting Repos
2019-05-20 11:16:32 +00:00
To sort repos provide `--sort [sortBy]` argument while building. Where `[sortBy]` can be `star`, `created`, `updated`, `pushed`,`full_name`. Default: `created`
2019-05-20 09:39:36 +00:00
2019-05-23 10:03:37 +00:00
```sh
$ gitfolio build <username> --sort star
2019-05-20 09:39:36 +00:00
```
#### Ordering Repos
To order the sorted repos provide `--order [orderBy]` argument while building. Where `[orderBy]` can be `asc` or `desc`. Default: `asc`
2019-05-23 10:03:37 +00:00
```sh
$ gitfolio build <username> --sort star --order desc
2019-05-20 09:39:36 +00:00
```
#### Customize Themes
Themes are specified using the `--theme [theme-name]` flag when running the `build` command. The available themes are
* `light`
* `dark`
> TODO: Add more themes
For example, the following command will build the website with the dark theme
2019-05-23 10:03:37 +00:00
```sh
$ gitfolio build <username> --theme dark
```
#### Customize background image
To customize the background image just provide `--background [url]` argument while building
2019-05-23 10:03:37 +00:00
```sh
$ gitfolio build <username> --background https://images.unsplash.com/photo-1557277770-baf0ca74f908?w=1634
```
You could also add in your custom CSS inside `index.css` to give it a more personal feel.
### Let's Publish
Head over to GitHub and create a new repository named `username.github.io`, where username is your username. Push the files inside`/dist` folder to repo you just created.
Go To `username.github.io` your site should be up!!
### Updating
To update your info, simply run
2019-05-23 10:03:37 +00:00
```sh
$ gitfolio update
```
This will update your info and your repository info.
To Update background or theme you need to run `build` command again.
### Add a Blog
2019-05-20 11:38:22 +00:00
To add your first blog run this command.
2019-05-23 10:03:37 +00:00
```sh
$ gitfolio blog my-first-blog
```
2019-05-20 11:38:22 +00:00
> (use "-" instead of spaces)
This will create a `my-first-blog` folder inside `blog`. Inside `my-first-blog` you will find an `index.html` file which contains all the necessary elements for writing a blog. Customize the content of the file to write your first blog.
This also adds content to `blog.json` file. This file helps in showcasing your blogs on your personal website as [cards](https://imfunniee.github.io/gitfolio/#blog_section). You could customize the JSON object that corresponds your current blog.
2019-05-22 05:59:20 +00:00
Blog Demo? [here](https://imfunniee.github.io/gitfolio/blog/my-first-post/)
Default JSON Format
```
{
"url_title": "my-first-blog", // the title you provide while creating a new blog, this appears in url
"title": "Lorem ipsum dolor sit amet", // main title of blog
"sub_title": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.", // sub-title of blog
"top_image": "https://images.unsplash.com/photo-1553748024-d1b27fb3f960?w=1450", // main image of blog
"visible": true // don't worry about this
}
```
More Arguments for Blog
```
2019-05-21 01:38:55 +00:00
--subtitle [subtitle] : gives blog a subtitle (Default : 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.')
--pagetitle [pagetitle] : gives blog page a title
--folder [folder] : give folder a title
```
> (use "-" instead of spaces)
## License
2019-05-24 06:42:23 +00:00
![GitHub](https://img.shields.io/github/license/imfunniee/gitfolio.svg?style=popout-square)