Skip to content
This repository was archived by the owner on Sep 3, 2024. It is now read-only.

Commit 01cbacf

Browse files
committed
Documentation update
1 parent c9dceff commit 01cbacf

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

readme.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,6 @@ Note: both the `build` and `dist` directories are disposable and can be regenera
7878

7979
To get started try running `gulp` from the command line. This fires `gulpfile.js/index.js` and should build a working copy of the included theme. The other command you will use from time to time is `gulp dist`, which builds a distribution copy.
8080

81-
You might also find a need for `gulp setup` which runs one-off setup tasks (which is also triggered by `gulp dist`). In the default installation this setup task only copies `normalize.css` to `src/scss` so it can be imported like a native SCSS file. This task is also run after `npm install` completes.
82-
8381
Configuration is handled by a single file: `gulpconfig.js`. If you leave the directory structure intact there won't be too much that needs changing here but I can think of two non-obvious components you might want to modify or at least look at:
8482

8583
* [BrowserSync](http://www.browsersync.io/) settings: if you are developing on a local web server you will want to enter the URL into `browsersync.proxy` and then change `watch.watcher` to `browsersync` to take it for a test drive. You'll know it's working when you run `gulp` and a new browser opens with a live copy of your web site. Make changes to any of the Sass files and they should be shown on the page almost immediately. Of course, BrowserSync really shines when you connect a mobile device to your development server, but for that you're on your own ;)
@@ -112,12 +110,12 @@ A few handy tips from the [Bower documentation](https://bower.io):
112110

113111
## WORKING WITH SASS
114112

115-
* This project now supports either [gulp-ruby-sass](https://github.com/sindresorhus/gulp-ruby-sass/) (which requires [the original Ruby implementation of Sass](https://github.com/sass/sass)) or [gulp-sass](https://www.npmjs.org/package/gulp-sass) (based on the newer and faster [libsass](https://github.com/sass/libsass), now active by default). Switch `styles.compiler` in the configuration file as needed! For reference: [Sass compatibility table](https://sass-compatibility.github.io/).
113+
* This project now supports either [gulp-sass](https://www.npmjs.org/package/gulp-sass) (based on the newer and faster [libsass](https://github.com/sass/libsass), now active by default) or [gulp-ruby-sass](https://github.com/sindresorhus/gulp-ruby-sass/) (which requires [the original Ruby implementation of Sass](https://github.com/sass/sass)). Switch `styles.compiler` in the configuration file as needed! For reference: [Sass compatibility table](https://sass-compatibility.github.io/).
116114
* [Sass](http://sass-lang.com/) files can be found in `/src/scss`. Gulp will not process Sass partials beginning with `_`; these need to be explicitly imported (see `style.scss` for an example). On the other hand, if you want to output any other CSS files just drop the underscore *e.g.* `editor-style.scss`.
117115
* Stylesheets are post-processed with [cssnano](http://cssnano.co/), a [PostCSS](https://github.com/postcss/postcss) plugin with [Autoprefixer](https://github.com/ai/autoprefixer) baked in, eliminating the need for vendor prefixes.
118116
* [Sourcemaps](http://www.html5rocks.com/en/tutorials/developertools/sourcemaps/) are generated by [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps) to make debugging stylesheets a snap. Note: all generated CSS is production-ready (*e.g.* minified and prefixed); sourcemaps only appear in the `build` directory.
119117
* Packages installed with Bower or npm are in the path by default so you can `@import` Sass files directly, as seen in `style.scss`.
120-
* This starter kit ships with [Normalize.css](https://necolas.github.io/normalize.css/) (imported into the `src/scss` directory using `gulp setup`; you might also like to explore the use of [normalize-scss](https://github.com/JohnAlbin/normalize-scss) for your project) and [Scut](https://davidtheclark.github.io/scut/), a minimalist library of useful Sass mixins and functions for the post-vendor prefixing era. Both of these are easy to remove if you're not interested in them.
118+
* This starter kit ships with [Normalize.css](https://necolas.github.io/normalize.css/) and [Scut](https://davidtheclark.github.io/scut/), a minimalist library of useful Sass mixins and functions for the post-vendor prefixing era. Both of these are easy to remove if you're not interested in them.
121119

122120

123121

@@ -177,7 +175,7 @@ Things can and will go wrong when working with new tools but there are a few sim
177175
* Better error handling (waiting for Gulp 4).
178176
* [Reduce unnecessary wrapper plugins](https://github.com/sogko/gulp-recipes/tree/master/unnecessary-wrapper-gulp-plugins).
179177
* RTL support with [gulp-rtlcss](https://github.com/jjlharrison/gulp-rtlcss)?
180-
* Explore using Gulp for I18n (a quick scan revealed nothing obviously useful).
178+
* Explore using Gulp for translation; see [gulp-potomo](https://github.com/felixzapata/gulp-potomo), [gulp-wp-pot](https://github.com/rasmusbe/gulp-wp-pot), and [gulp-checktextdomain](https://github.com/felixzapata/gulp-checktextdomain) for examples.
181179
* Browserify integration? The existing bundles/chunks system is very DIY and non-standard. Feedback welcome.
182180
* More good ideas from [Gulp recipes](https://github.com/gulpjs/gulp/tree/master/docs/recipes).
183181

0 commit comments

Comments
 (0)