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

update(docs): Update README for serving docs site #6436

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 3 additions & 23 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,6 @@ generator built by [Pete Bacon Darwin](https://github.com/petebacondarwin).
To view the Live Docs (locally):

1. Install the dependencies using `npm install`
2. Install the dependencies using `bower install`
3. Build the docs using `gulp docs`
4. Run `gulp watch` to auto-rebuild docs (optional)
5. Start an HTTP Server; the example below uses port 8080
6. Open browser at `http://localhost:8080`

```bash
# Build & deploy docs to `dist/docs`
gulp docs

# Watch source dirs for changes and rebuild
gulp watch

# Use the built-in gulp server with live reload
gulp server

# Alternatively, install httpster globally; if not already installed
npm install -g httpster

# And then launch the webserver
# NOTE: unlike `gulp server` this will not auto-reload the HTML
httpster -p 8080 -d ./dist/docs
```
1. Build the docs using `gulp docs`
1. Run `gulp watch site --dev` to serve and live reload the docs
1. Open [http://localhost:8080](http://localhost:8080)