nordgedanken-github-io

git clone git://archive.git.mtrnord.blog/Nordgedanken/nordgedanken-github-io.git
Log | Files | Refs | README | LICENSE

README.md (2066B)

      1 # Particle Jekyll Theme
      2 
      3 ![](./particle.jpg)
      4 
      5 This is a simple and minimalist template for Jekyll designed for developers that want to show of their portfolio.
      6 
      7 The Theme features:
      8 
      9 - Gulp
     10 - SASS
     11 - Sweet Scroll
     12 - Particle.js
     13 - BrowserSync
     14 - Font Awesome and Devicon icons
     15 - Google Analytics
     16 - Info Customization
     17 
     18 ## Basic Setup
     19 
     20 1. [Install Jekyll](http://jekyllrb.com)
     21 2. Fork the [Particle Theme](https://github.com/nrandecker/particle/fork)
     22 3. Clone the repo you just forked.
     23 4. Edit `_config.yml` to personalize your site.
     24 
     25 ## Site and User Settings
     26 
     27 You have to fill some informations on `_config.yml` to customize your site.
     28 
     29 ```
     30 # Site settings
     31 description: A blog about lorem ipsum dolor sit amet
     32 baseurl: "" # the subpath of your site, e.g. /blog/
     33 url: "http://localhost:3000" # the base hostname & protocol for your site
     34 
     35 # User settings
     36 username: Lorem Ipsum
     37 user_description: Anon Developer at Lorem Ipsum Dolor
     38 user_title: Anon Developer
     39 email: anon@anon.com
     40 twitter_username: lorem_ipsum
     41 github_username:  lorem_ipsum
     42 gplus_username:  lorem_ipsum
     43 ```
     44 
     45 **Don't forget to change your url before you deploy your site!**
     46 
     47 ## Color and Particle Customization
     48 - Color Customization
     49   - Edit the sass variables
     50 - Particle Customization
     51   - Edit the json data in particle function in app.js
     52   - Refer to [Particle.js](https://github.com/VincentGarreau/particles.js/) for help
     53 
     54 ## Running the blog in local
     55 
     56 In order to compile the assets and run Jekyll on local you need to follow those steps:
     57 
     58 - Install [NodeJS](https://nodejs.org/)
     59 - Run `npm install`
     60 - Run `gulp`
     61 
     62 ## Questions
     63 
     64 Having any issues file a [GitHub Issue](https://github.com/nrandecker/particle/issues/new).
     65 
     66 ## License
     67 
     68 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.
     69 
     70 ## Credits
     71 
     72 This theme was partially designed with the inspiration from these fine folks
     73 - [Willian Justen](https://github.com/willianjusten/will-jekyll-template)
     74 - [Vincent Garreau](https://github.com/VincentGarreau/particles.js/)