Skip to content

Commit

Permalink
Add instructions for locally viewing the source documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
TimvdLippe committed Feb 21, 2018
1 parent 821f335 commit 206d361
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,7 @@ dist

# misc
.DS_Store
npm-debug.log
npm-debug.log

# Analyzer output used in the docs
analysis.json
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,3 +149,14 @@ to run tests on a subset of available browsers, or to run tests remotely using S

See the [`web-component-tester` README](https://github.com/Polymer/web-component-tester) for
information on configuring the tool.

### Viewing the source documentation locally

You can view the updates you make to the source documentation locally with the following steps.
Make sure to rerun step 1 after every change you make.

1. Run `polymer analyze > analysis.json`

1. Run `polymer serve`

1. Open `http://127.0.0.1:PORT/components/polymer/` to view the documentation

0 comments on commit 206d361

Please sign in to comment.