https://github.com/iamsahdeep/iamsahdeep.github.io
https://github.com/iamsahdeep/iamsahdeep.github.io
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/iamsahdeep/iamsahdeep.github.io
- Owner: iamSahdeep
- License: mit
- Created: 2017-05-14T10:42:23.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-10-31T14:12:11.000Z (almost 8 years ago)
- Last Synced: 2025-01-02T02:42:29.835Z (over 1 year ago)
- Language: HTML
- Size: 4.73 MB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Particle Jekyll Theme
This is a simple and minimalist template for Jekyll designed for developers that want to show their portfolio.
The Theme features:
- Gulp
- SASS
- Sweet Scroll
- Particle.js
- BrowserSync
- Font Awesome and Devicon icons
- Google Analytics
- Information Customization
## Basic Setup
1. [Install Jekyll](http://jekyllrb.com)
2. Fork the [Particle Theme](https://github.com/nrandecker/particle/fork)
3. Clone the repo you just forked.
4. Edit `_config.yml` to personalize your site.
## Site and User Settings
You have to fill some informations on `_config.yml` to customize your site.
```
# Site settings
description: A blog about lorem ipsum dolor sit amet
baseurl: "" # the subpath of your site, e.g. /blog/
url: "http://localhost:3000" # the base hostname & protocol for your site
# User settings
username: Lorem Ipsum
user_description: Anon Developer at Lorem Ipsum Dolor
user_title: Anon Developer
email: anon@anon.com
twitter_username: lorem_ipsum
github_username: lorem_ipsum
gplus_username: lorem_ipsum
```
**Don't forget to change your url before you deploy your site!**
## Color and Particle Customization
- Color Customization
- Edit the sass variables
- Particle Customization
- Edit the json data in particle function in app.js
- Refer to [Particle.js](https://github.com/VincentGarreau/particles.js/) for help
## Running the blog in local
In order to compile the assets and run Jekyll on local you need to follow those steps:
- Install [NodeJS](https://nodejs.org/)
- Run `npm install`
- Run `gulp`
## License
This theme is free and open source software, distributed under the The MIT License. So feel free to use this Jekyll theme anyway you want.
## Credits
This theme was partially designed with the inspiration from these two fine folks
- [Willian Justen](https://github.com/willianjusten/will-jekyll-template)
- [Vincent Garreau](https://github.com/VincentGarreau/particles.js/)