Skip to content

Latest commit

 

History

History
93 lines (55 loc) · 2.47 KB

README.md

File metadata and controls

93 lines (55 loc) · 2.47 KB
Raw

lit-element Documentation

This folder holds the source for the lit-element documentation site. Guides are written in Markdown, and the site is built using the Jekyll static site generator.

This section describes how to build the documentation site.

Prerequisites

To build the documentation site, you need Jekyll, Node, npm, and Polymer CLI.

If you already have Ruby and the gem pacakge manager, run the following command to install Jekyll:

gem install bundler jekyll

For more information, see the Jekyll website.

To install Polymer CLI:

npm install -g polymer-cli

Previewing the docs requires the App Engine Standard Environment for Python 2.7.

Setup

  1. Clone or download a copy of this repo.

  2. Install npm dependencies for the docs site.

    cd lit-element/docs
npm install

Building and previewing

To build the documentation site and preview it from a local server:

cd docs
npm run build
npm run serve

Point a browser at localhost:8080 to preview the site. To use a different port, run:

npm run serve -- --port <PORTNUMBER>

The generated API docs are checked in, so you don't need to build the API docs unless you're making changes to the doc comments in the lit-element source.

To regenerate the API docs and rebuild the site, run the following command:

npm run build-all

Deployment

To build and deploy a new version of the site:

npm run deploy

(You must have permission to update the App Engine project to deploy the site.)

The site is staged at a new URL (for example, https://20181207t151022-dot-polymer-lit-element.appspot.com). When ready, use the App Engine console to migrate traffic to the new version.

Sometimes it's useful to stage to a specific, named version. For example, when iterating on a new doc or design change, you may want to stage to an easily-to-remember version name, like new-tooling-section.

To push to a named App Engine version, specify the version on the command line:

npm run deploy -- --version=<VERSION>

This command stages the docs at https://<VERSION>-dot-polymer-lit-element.appspot.com.

By specifying the version on the command line, you can update an existing staged version.

To make a staged version live, migrate traffic in the App Engine console or from the command line:

gcloud app services set-traffic --splits <VERSION>=1