Skip to content

Commit

Permalink
🔀 /doc
Browse files Browse the repository at this point in the history
Add subumodule nrandecker/particle
  • Loading branch information
ys3669 committed Sep 18, 2017
1 parent 5170ff8 commit 5d27e3b
Show file tree
Hide file tree
Showing 29 changed files with 4,670 additions and 38 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "doc/particle"]
path = doc/particle
url = https://github.com/nrandecker/particle.git
Binary file added doc/.DS_Store
Binary file not shown.
3 changes: 3 additions & 0 deletions doc/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
_site
.sass-cache
node_modules
21 changes: 21 additions & 0 deletions doc/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 Nathan Randecker

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
74 changes: 74 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Particle Jekyll Theme

![](./particle.jpg)

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. 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: [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/)
- Run `npm install`
- 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/)
21 changes: 20 additions & 1 deletion doc/_config.yml
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
theme: jekyll-theme-merlot
# Site settings
title: A blog about lorem ipsum dolor sit amet
description: A blog about lorem ipsum dolor sit amet
# baseurl: "/particle" # the subpath of your site, e.g. /blog
# url: "localhost:3000" # the base hostname & protocol for your site e.g. http://willianjusten.com.br

# User settings
username: Anon Developer
user_description: Bicycle rights irony actually neutra typewriter lyft. Man bun taxidermy put a bird on it, umami yr ramps pop-up ugh bushwick chia lo-fi. Occupy bitters pour-over snackwave you probably haven't heard of them small batch. Cornhole mustache man bun letterpress echo park VHS.
user_title: Software Developer
email: [email protected]
twitter_username: lorem_ipsum
github_username: lorem_ipsum
gplus_username: lorem_ipsum

# Google-analytics
google-analytics:
id: ""

exclude: ['package.json', 'src' , 'node_modules']
32 changes: 32 additions & 0 deletions doc/_includes/about.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<div class="container">
<div class="user-details">
<h3> My Expertise </h3>
<p> {{site.user_description}} </p>
</div>
<div class="row user">
<div class="four columns">
<h4>Design</h4>
<i class="devicon-html5-plain-wordmark"></i>
<i class="devicon-bootstrap-plain-wordmark colored"></i>
<i class="devicon-sass-original colored"></i>
<p>Mumblecore hexagon kombucha, pitchfork four loko raclette intelligentsia master cleanse.
Vinyl XOXO lumbersexual</p>
</div>
<div class="four columns">
<h4>Code</h4>
<i class="devicon-javascript-plain colored"></i>
<i class="devicon-react-original-wordmark colored"></i>
<i class="devicon-nodejs-plain-wordmark"></i>
<p>Mumblecore hexagon kombucha, pitchfork four loko raclette intelligentsia master cleanse.
Vinyl XOXO lumbersexual</p>
</div>
<div class="four columns">
<h4>Tools</h4>
<i class="devicon-git-plain"></i>
<i class="devicon-gulp-plain colored"></i>
<i class="devicon-atom-original-wordmark"></i>
<p>Mumblecore hexagon kombucha, pitchfork four loko raclette intelligentsia master cleanse.
Vinyl XOXO lumbersexual</p>
</div>
</div>
</div>
8 changes: 8 additions & 0 deletions doc/_includes/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<footer class="footer">
<p>&copy; {{site.username}}</p>
<p>Build with Jekyll and <span class="love"></span> by <a href="https://nrandecker.github.io">Nathan Randecker</a></p>
</footer>
<script src="//cdn.jsdelivr.net/particles.js/2.0.0/particles.min.js"></script>
<script src="{{ "/assets/js/sweet-scroll.min.js" | prepend: site.baseurl }}"></script>
<script src="{{ "/assets/js/main.js" | prepend: site.baseurl }}"></script>
{% include google-analytics.html %}
11 changes: 11 additions & 0 deletions doc/_includes/google-analytics.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Google Analytics -->
{% if site.google-analytics %}
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', '{{ site.google-analytics.id }}', 'auto');
ga('send', 'pageview');
</script>
{% endif %}
13 changes: 13 additions & 0 deletions doc/_includes/head.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">

<title>{% if page.title %}{{ page.title }}{% else %}{{ site.title }}{% endif %}</title>
<meta name="description" content="{% if page.description %}{{ page.description | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">

<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/skeleton/2.0.4/skeleton.min.css">
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css">
<link rel="stylesheet" href="//cdn.rawgit.com/konpa/devicon/master/devicon.min.css">
<link rel="stylesheet" href="{{ "/assets/css/main.css" | prepend: site.baseurl }}">
</head>
17 changes: 17 additions & 0 deletions doc/_includes/header.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<div id="particles-js">
<div class="content">
<h1>
<span class="site-title">{{site.username}}</span>
<span class="site-description">{{site.user_title}}</span>
</h1>
<div class="icons-header">
<a aria-label="Send email" href="mailto:{{site.email}}"><i class="icon fa fa-envelope"></i></a>
<a aria-label="My Twitter" target="_blank" href="https://twitter.com/{{site.twitter_username}}"><i class="icon fa fa-twitter" aria-hidden="true"></i></a>
<a aria-label="My Google Plus" target="_blank" href="https://plus.google.com/{{site.gplus_username}}/posts"><i class="icon fa fa-google-plus" aria-hidden="true"></i></a>
<a aria-label="My Github" target="_blank" href="https://github.com/{{site.github_username}}"><i class="icon fa fa-github-alt" aria-hidden="true"></i></a>
</div>
<a class="link" href="#about" data-scroll>About Me</a>
<a class="link" href="#projects" data-scroll>Projects</a>
</div>
<a class="down" href="#about" data-scroll><i class="icon fa fa-chevron-down" aria-hidden="true"></i></a>
</div>
29 changes: 29 additions & 0 deletions doc/_includes/projects.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<div class="container">
<div class="user-details">
<h3> Featured Projects </h3>
</div>
<div class="row user-projects">
<div class="six columns images">
<img alt="mountains" src="{{ "/assets/img/mountains.jpg" | prepend: site.baseurl }}" />
</div>
<div class="six columns">
<h5> Project Title </h5>
<li> Featured Skills</li>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p>
<a class="project-link" href="#">Check it out</a>
</div>
</div>
<div class="row user-projects">
<div class="six columns">
<img alt="mountains" src="{{ "/assets/img/skate.jpg" | prepend: site.baseurl }}" />
</div>
<div class="six columns">
<h5> Project Title </h5>
<ul>
<li> Featured Skills</li>
</ul>
<p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p>
<a class="project-link" href="#">Check it out</a>
</div>
</div>
</div>
14 changes: 14 additions & 0 deletions doc/_layouts/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html lang="en">
{% include head.html %}
<body>
{% include header.html %}
<section id="about">
{% include about.html %}
</section>
<section id="projects">
{% include projects.html %}
</section>
{{ content }}
{% include footer.html %}
</body>
1 change: 1 addition & 0 deletions doc/assets/css/main.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added doc/assets/img/mountains.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/assets/img/skate.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions doc/assets/js/main.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions doc/assets/js/sweet-scroll.min.js

Large diffs are not rendered by default.

79 changes: 79 additions & 0 deletions doc/gulpfile.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
var gulp = require('gulp');
var csso = require('gulp-csso');
var uglify = require('gulp-uglify');
var concat = require('gulp-concat');
var sass = require('gulp-sass');
var plumber = require('gulp-plumber');
var cp = require('child_process');
var imagemin = require('gulp-imagemin');
var browserSync = require('browser-sync');

var jekyllCommand = (/^win/.test(process.platform)) ? 'jekyll.bat' : 'jekyll';

/*
* Build the Jekyll Site
* runs a child process in node that runs the jekyll commands
*/
gulp.task('jekyll-build', function (done) {
return cp.spawn(jekyllCommand, ['build'], {stdio: 'inherit'})
.on('close', done);
});

/*
* Rebuild Jekyll & reload browserSync
*/
gulp.task('jekyll-rebuild', ['jekyll-build'], function () {
browserSync.reload();
});

/*
* Build the jekyll site and launch browser-sync
*/
gulp.task('browser-sync', ['jekyll-build'], function() {
browserSync({
server: {
baseDir: '_site'
}
});
});

/*
* Compile and minify sass
*/
gulp.task('sass', function() {
gulp.src('src/styles/**/*.scss')
.pipe(plumber())
.pipe(sass())
.pipe(csso())
.pipe(gulp.dest('assets/css'));
});

/*
* Minify images
*/
gulp.task('imagemin', function() {
return gulp.src('src/img/**/*.{jpg,png,gif}')
.pipe(plumber())
.pipe(imagemin({ optimizationLevel: 3, progressive: true, interlaced: true }))
.pipe(gulp.dest('assets/img/'));
});

/**
* Compile and minify js
*/
gulp.task('js', function(){
return gulp.src('src/js/**/*.js')
.pipe(plumber())
.pipe(concat('main.js'))
.pipe(uglify())
.pipe(gulp.dest('assets/js/'))
});

gulp.task('watch', function() {
gulp.watch('src/styles/**/*.scss', ['sass']);
gulp.watch('src/js/**/*.js', ['js']);
gulp.watch('src/img/**/*.{jpg,png,gif}', ['imagemin']);
gulp.watch(['*html', '_includes/*html', '_layouts/*.html'], ['jekyll-rebuild']);
});

gulp.task('default', ['js', 'sass', 'browser-sync', 'watch']);
3 changes: 3 additions & 0 deletions doc/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
layout: default
---
37 changes: 0 additions & 37 deletions doc/index.md

This file was deleted.

Loading

0 comments on commit 5d27e3b

Please sign in to comment.