https://github.com/fklc/.dev
Same as https://github.com/FKLC/nodeless-gitfolio repo. Just to keep it untouched
https://github.com/fklc/.dev
Last synced: 28 days ago
JSON representation
Same as https://github.com/FKLC/nodeless-gitfolio repo. Just to keep it untouched
- Host: GitHub
- URL: https://github.com/fklc/.dev
- Owner: FKLC
- License: gpl-3.0
- Created: 2019-08-27T06:23:55.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-28T02:00:19.000Z (over 2 years ago)
- Last Synced: 2025-01-09T22:19:47.392Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://fklc.dev
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Purpose of fork
Gitfolio needs to install Node and I've just uninstalled it but I wanted to use gitfolio so here is my implementation of gitfolio. To use this you can just fork and publish at Github Pages and you are ready to go!
### Changes
- Removed jQuery
- Removed Loading Spinner
- Removed Blog Section (It can be achieved without Node but I'm not going to write posts so I removed blog)
- Removed Service Worker Because For Some Reason It Didn't Worked As I expected.
- Changed Background Image To Use [Unsplash Source](https://source.unsplash.com/)
### How it works
It uses Github's search API to get your forked and own repos and just renders them. I'm really bad at JS but I added comments on code to explain code.
# Gitfolio [](https://twitter.com/intent/tweet?text=personal%20website%20and%20a%20blog%20for%20every%20github%20user%20&url=https://github.com/imfunniee/gitfolio)     
### personal website + blog for every github user
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.
# Getting Started
### Let's Install
Install gitfolio
```sh
npm i gitfolio -g
```
### Let's Build
```sh
gitfolio build
```
`` is your username on github. This will build your website using your GitHub username and put it in the `/dist` folder.
To run your website use `run` command (please refrain from using this for now)
```sh
gitfolio run
```
🎉 Congrats, you just made yourself a personal website!
### Let's Customize
#### Forks
To include forks on your personal website just provide `-f` or `--fork` argument while building
```sh
$ gitfolio build -f
```
#### Sorting Repos
To sort repos provide `--sort [sortBy]` argument while building. Where `[sortBy]` can be `star`, `created`, `updated`, `pushed`,`full_name`. Default: `created`
```sh
$ gitfolio build --sort star
```
#### Ordering Repos
To order the sorted repos provide `--order [orderBy]` argument while building. Where `[orderBy]` can be `asc` or `desc`. Default: `asc`
```sh
$ gitfolio build --sort star --order desc
```
#### 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
```sh
$ gitfolio build --theme dark
```
#### Customize background image
To customize the background image just provide `--background [url]` argument while building
```sh
$ gitfolio build --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
```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
To add your first blog run this command.
```sh
$ gitfolio blog my-first-blog
```
> (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.
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
```
--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)
## Support
Loved My Work? Keep me awake at night by buying me a Coffee ☕
## License
