From 206d361072eb9f3aa7efb38c67559aea7ed62f13 Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Wed, 21 Feb 2018 12:01:05 +0100 Subject: [PATCH 1/2] Add instructions for locally viewing the source documentation --- .gitignore | 5 ++++- CONTRIBUTING.md | 11 +++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 3e28a40710..d3d42def04 100644 --- a/.gitignore +++ b/.gitignore @@ -11,4 +11,7 @@ dist # misc .DS_Store -npm-debug.log \ No newline at end of file +npm-debug.log + +# Analyzer output used in the docs +analysis.json diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b6d381e2c9..8342c0d248 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 From d93dd1ceeb76291496204634e3df96dc959c69d5 Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Tue, 27 Feb 2018 11:40:23 +0100 Subject: [PATCH 2/2] Add iron-component-page dev-dependency --- bower.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/bower.json b/bower.json index b2f988911a..ae2bcf5033 100644 --- a/bower.json +++ b/bower.json @@ -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": {