https://github.com/casprwang/my-personal-website
personal web using gulp / jekyll / sass / jade(pug)
https://github.com/casprwang/my-personal-website
Last synced: 7 months ago
JSON representation
personal web using gulp / jekyll / sass / jade(pug)
- Host: GitHub
- URL: https://github.com/casprwang/my-personal-website
- Owner: casprwang
- Created: 2016-06-28T12:38:06.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-07-07T07:22:11.000Z (over 9 years ago)
- Last Synced: 2025-02-02T01:41:28.327Z (8 months ago)
- Language: CSS
- Homepage:
- Size: 33.5 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
jekyll-gulp-sass-browser-sync
=============================
A starter project including full setup for Jekyll, GulpJS, SASS, AutoPrefixer & BrowserSync
Here's a 1.5min [screencast](http://quick.as/pvrslgx) showing what you get.
And here's a GIF showing the CSS injecting.
## System Preparation
To use this starter project, you'll need the following things installed on your machine.
1. [Jekyll](http://jekyllrb.com/) - `$ gem install jekyll`
2. [NodeJS](http://nodejs.org) - use the installer.
3. [GulpJS](https://github.com/gulpjs/gulp) - `$ npm install -g gulp` (mac users may need sudo)
## Local Installation
1. Clone this repo, or download it into a directory of your choice.
2. Inside the directory, run `npm install`.
## Usage
**development mode**
This will give you file watching, browser synchronisation, auto-rebuild, CSS injecting etc etc.
```shell
$ gulp
```
**jekyll**
As this is just a Jekyll project, you can use any of the commands listed in their [docs](http://jekyllrb.com/docs/usage/)
## Deploy with Gulp
You can easily deploy your site build to a gh-pages branch. First, follow the instructions at [gulp-gh-pages](https://github.com/rowoot/gulp-gh-pages) to get your branch prepared for the deployment and to install the module. Then, in `gulpfile.js` you'll want to include something like the code below. `gulp.src()` needs to be the path to your final site folder, which by default will be `_site`. If you change the `destination` in your `_config.yml` file, be sure to reflect that in your gulpfile.
```javascript
var deploy = require("gulp-gh-pages");
gulp.task("deploy", ["jekyll-build"], function () {
return gulp.src("./_site/**/*")
.pipe(deploy());
});
```