Skip to content

Commit

Permalink
Merge pull request #5124 from Polymer/docs-instructions
Browse files Browse the repository at this point in the history
Add instructions for locally viewing the source documentation
  • Loading branch information
Steve Orvell authored Feb 27, 2018
2 parents 63d9122 + d93dd1c commit f04ef30
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 2 deletions.
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
3 changes: 2 additions & 1 deletion bower.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
},
"devDependencies": {
"web-component-tester": "^6.0.0",
"test-fixture": "PolymerElements/test-fixture#3.0.0-rc.1"
"test-fixture": "PolymerElements/test-fixture#3.0.0-rc.1",
"iron-component-page": "PolymerElements/iron-component-page#^3.0.1"
},
"private": true,
"resolutions": {
Expand Down

0 comments on commit f04ef30

Please sign in to comment.