From c834f869907061bb80683993c6d13c3704cede8f Mon Sep 17 00:00:00 2001 From: Andrew Joslin Date: Wed, 28 May 2014 08:59:51 -0600 Subject: [PATCH] docs(README): update explanation of docs & demos generation --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dcd56dc078..591d0d94b5 100644 --- a/README.md +++ b/README.md @@ -101,15 +101,24 @@ For most cases, you'll need AngularJS as well. This is bundled in `js/angular/` ### Documentation -* To test documentation, follow these steps: - 1. Clone ionic-site to `./temp/ionic-site` - this is where the `gulp docs` task builds to. `./temp` is the folder that travis uses to do all of its tasks. - - `mkdir temp && git clone git@github.com:driftyco/ionic-site temp/ionic-site` - 2. Make jekyll rebuild whenever you change the site. - - `cd temp/ionic-site && jekyll serve -w` +* Documentation is generated into `dist/ionic-site`. To test documentation properly, follow these steps: + 1. Clone ionic-site into `./dist/ionic-site`. + - `git clone git@github.com:driftyco/ionic-site temp/ionic-site dist/ionic-site` + 2. Start jekyll, telling it to rebuild whenever the site changes. + - `cd dist/ionic-site && jekyll serve -w` 3. Go back to project root and build the docs - - `gulp docs` + - `gulp docs [--doc-version=(versionName|nightly)]` 4. Open localhost:4000 and see your changes! Re-run `gulp docs` again whenever you change something, and jekyll will update the site. +### Demos / Kitchen Sink + +* The demo site is generated into `dist/ionic-demo`. To test the demons, follow these steps: + 1. Run `gulp demos [--demo-version=(versionName|nightly)]` + 2. Start an http server from `dist/ionic-demo`: + - `cd dist/ionic-demo && python -m SimpleHTTPServer` + 3. Navigate to `http://localhost:8000/{versionName|nightly}` and use the demos + 4. Run `gulp demos` again whenever you change the demos + ### Commit Conventions * Uses http://github.com/ajoslin/conventional-changelog conventions