Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rudemex/rudemex.github.io
https://github.com/rudemex/rudemex.github.io
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/rudemex/rudemex.github.io
- Owner: rudemex
- License: mit
- Created: 2020-05-05T15:53:10.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-12T01:50:00.000Z (almost 2 years ago)
- Last Synced: 2023-03-24T04:31:25.292Z (over 1 year ago)
- Language: SCSS
- Size: 1.27 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
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 of their portfolio.
The Theme features:
- Gulp
- SASS
- Sweet Scroll
- Particle.js
- BrowserSync
- Font Awesome and Devicon icons
- Google Analytics
- Info Customization
## Basic Setup
1. [Install Jekyll](http://jekyllrb.com)
2. Clone the particle theme: `git clone https://github.com/nrandecker/particle.git`
3. 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: [email protected]
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/)
- Install [Jekyll](https://jekyllrb.com): `sudo gem install bundler jekyll`
- Install [Yarn](https://yarnpkg.com/): `npm install -g yarn`
- Install dependencies: `yarn`
- Run: `gulp`
## Questions
Having any issues file a [GitHub Issue](https://github.com/nrandecker/particle/issues/new).
## 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 fine folks
- [Willian Justen](https://github.com/willianjusten/will-jekyll-template)
- [Vincent Garreau](https://github.com/VincentGarreau/particles.js/)