@@ -22,7 +22,7 @@ This is an opinionated Jekyll setup that takes a gulp instance and registers gul
2222### Features:
2323* Project setup
2424* Browser Sync and Local Dev server
25- * Sass, autoprefixer , and minification of CSS
25+ * Sass, Autoprefixer , and minification of CSS
2626* Webpack and Babel
2727* Deployment to S3
2828
@@ -37,7 +37,7 @@ require('jekyll-tasks')(gulp);
3737Once you do this, you can use the following
3838___
3939#### Primary Tasks:
40- ` gulp setup-project ` - Initializes your project src code in a directory called ` src ` . The directory structure looks like
40+ * ` gulp setup-project ` - Initializes your project src code in a directory called ` src ` . The directory structure looks like
4141```
4242src\
4343 _drafts\
5151 var\
5252 src\
5353 main.scss (this is the Sass entry point)
54- builds\ (compiled resources, you should gitignore this )
54+ builds\ (compiled resources)
5555 static\
5656 font\
5757 images\
6161 archive.html
6262 index.html
6363```
64- ` gulp dev ` - Launches your development server and begins watching your files
65-
66- ` gulp deploy ` - Builds and publishes your site to S3
64+ You should add the following to your .gitignore after your project is set up
65+ ```
66+ _site
67+ src/builds
68+ ```
69+ * ` gulp dev ` - Launches your development server and begins watching your files
70+ * ` gulp deploy ` - Builds and publishes your site to S3
6771___
6872#### Other Tasks (these shouldn't need to be used normally):
69- ` gulp jekyll-build ` - Builds your jekyll site into ` _site `
70-
71- ` gulp jekyll-build:drafts ` - Same as ` jekyll-build ` but with drafts included
72-
73- ` gulp jekyll-rebuild ` - Same as ` jekyll-build:drafts ` but reloads the page
74-
75- ` gulp browser-sync ` - Launches a browser-sync server
76-
77- ` gulp sass ` - Compiles the development version of your CSS
78-
79- ` gulp sass:prod ` - Same as the previous but the CSS is minified
80-
81- ` gulp webpack:dev ` - Compiles the development version of your Javascript
82-
83- ` gulp webpack:prod ` - Compiles the production version of your Javascript
84-
85- ` gulp publish ` - Takes your ` _site ` directory and publishes it to S3
86-
87- ` gulp watch ` - Watches your file system for changes and executes the appropriate task
73+ * ` gulp jekyll-build ` - Builds your jekyll site into ` _site `
74+ * ` gulp jekyll-build:drafts ` - Same as ` jekyll-build ` but with drafts included
75+ * ` gulp jekyll-rebuild ` - Same as ` jekyll-build:drafts ` but reloads the page
76+ * ` gulp browser-sync ` - Launches a browser-sync server
77+ * ` gulp sass ` - Compiles the development version of your CSS
78+ * ` gulp sass:prod ` - Same as the previous but the CSS is minified
79+ * ` gulp webpack:dev ` - Compiles the development version of your Javascript
80+ * ` gulp webpack:prod ` - Compiles the production version of your Javascript
81+ * ` gulp publish ` - Takes your ` _site ` directory and publishes it to S3
82+ * ` gulp watch ` - Watches your file system for changes and executes the appropriate task
8883
8984___
9085## Options:
@@ -95,11 +90,10 @@ let options = {};
9590require (' jekyll-tasks' )(gulp, options);
9691```
9792
98- ` options.webpackDevConfig ` - Development Webpack Config. See the source code for the default config
99-
100- ` options.webpackProdConfig ` - Production Webpack Config. See the source code for the default config
93+ * ` options.webpackDevConfig ` - Development Webpack Config. See the source code for the default config
94+ * ` options.webpackProdConfig ` - Production Webpack Config. See the source code for the default config
95+ * ` options.awsConfig ` - Your awsConfig for publishing your site. At a minimum, it should look like this...
10196
102- ` options.awsConfig ` - Your awsConfig for publishing your site. At a minimum, it should look like this...
10397``` json
10498{
10599 "params" : {
0 commit comments