Skip to content

rianby64/docs

 
 

Repository files navigation

Polymer documentation site

https://www.polymer-project.org/

Install

git clone https://github.com/Polymer/docs2 --recursive
cd docs2
npm install

Note: --recursive will init and checkout submodules as well.

Running the site

The first time you run the site, run gulp to build the site in its entirety:

gulp

Then start the App Engine dev server on dist/app.yaml:

dev_appserver.py dist/

The site will be served from http://localhost:8080.

Making changes / watching files / live reload

If you're marking changes use the watch task. Optionally add --reload to live reload the tab when changes are saved.

gulp watch --reload

The site will be served on http://localhost:3000. Making changes will refresh the browser tab.

Optional flags:

  • --reload: refreshes the browser tab when changes are made
  • --open: opens a new browser tab when gulp watch is started

Tip - run gulp help to see the list of available gulp tasks.

Run tests

Install WebTest framework:

pip install WebTest

Then run:

npm test

Deployment

Build and deploy version YYY-MM-DD of the site:

gulp
npm run deploy YYYY-MM-DD

About

Documentation for Polymer

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 96.0%
  • JavaScript 1.6%
  • Python 1.3%
  • Other 1.1%