Skip to content
This repository has been archived by the owner on Mar 16, 2021. It is now read-only.

Commit

Permalink
Merge pull request #18 from cferdinandi/development
Browse files Browse the repository at this point in the history
Updated readme
  • Loading branch information
Chris Ferdinandi committed Oct 20, 2014
2 parents 1ca53e4 + f4699b4 commit bf51101
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,14 @@ gulp-boilerplate/
| |—— index.html
| |—— # other docs
|—— src/
| |—— docs/
| | |—— _templates/
| | | |—— _header.html
| | | |—— _footer.html
| | |—— assets/
| | | |—— # doc-specific assets
| | |—— index.html
| | |—— # other docs
| |—— js/
| | |—— classList.js
| | |—— myplugin.js
Expand Down Expand Up @@ -125,6 +133,14 @@ Unit test results are printed in terminal, but you can also view them in a brows

SVG files placed in the `src` > `svg` directory will be compiled into a single SVG sprite called `icons.svg` in the `dist` > `svg` directory.

### Documentation

Add HTML or markdown (`.md` or `.markdown`) files to your `docs` folder in `src`.

The `_templates` directory in `src` contains the `_header.html` and `_footer.html` templates. These are automatically added to the beginning and end of each documentation page. You can also add your own templates to the `_templates` directory. Include template files in your docs by writing `@@include('path-to-file')` on its own line in your markup (or markdown).

Files placed in the `assets` directory will be moved over as-is to the `docs` directory. Keel will also add a copy of your `dist` files so you can use them in your documentation.



## Options and Settings
Expand Down Expand Up @@ -193,6 +209,8 @@ Gulp Boilerplate is licensed under the [MIT License](http://gomakethings.com/mit

Gulp Boilerplate uses [semantic versioning](http://semver.org/).

* v1.1.1 - October 20, 2014
* Added documentation on generating docs.
* v1.1.0 - October 18, 2014
* Added documentation generator.
* Added SVG sprite generator.
Expand Down

0 comments on commit bf51101

Please sign in to comment.