Skip to content

Commit e5a4285

Browse files
committed
Add usable instructions for running locally
1 parent 3b0a3c1 commit e5a4285

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,12 @@ $ npm install
1919
$ grunt
2020
```
2121

22-
Once you've built the site, open `build/index.html` in your web browser to preview.
22+
Running `grunt` will build the site and rebuild when docs changes. You need to use a local webserver to preview in your web browser. One easy option is to use [http-server](https://www.npmjs.org/package/http-server) (installable via `npm install -g http-server`). You need to run it from the `/build` directory and explicitly include `html` as the default extension (add `-s` for silent mode):
2323

24+
```sh
25+
docs.ractive.org/build>http-server -e html
26+
```
27+
Open `localhost` on the port specified (usually `8080`), and it should redirect to `localhost:8080/latest/get-started`. Refresh to pick up changes made in docs.
2428

2529
Contributing
2630
------------

0 commit comments

Comments
 (0)