https://github.com/unbug/polymer-old-doc

https://github.com/unbug/polymer-old-doc

Last synced: 9 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/unbug/polymer-old-doc
• Owner: unbug
• Created: 2014-07-29T01:36:38.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-07-29T01:39:22.000Z (over 10 years ago)
• Last Synced: 2023-03-27T12:30:09.128Z (over 1 year ago)
• Language: JavaScript
• Size: 11.8 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md

Awesome Lists containing this project

README

        
Polymer docs are mostly in Markdown with some HTML. [Jekyll][jekyll] is used to generate the static HTML for the site. The output is generated into a folder called `_site` and served from Google App Engine.

## Install the requirements

We use Jekyll 1.0+ and [Grunt][grunt] to generate the documentation. You'll need to install the requirements before working on the docs (these instructions assume [NPM is already installed](http://nodejs.org/download/)):

    sudo gem install jekyll

    sudo npm install -g grunt-cli

    npm install

You'll also need the App Engine dev server to preview the docs locally. [Download the SDK](https://developers.google.com/appengine/downloads).

## Making edits and previewing changes

This repo (`polymer/docs`) is where the documentation source files live. To make a change:

1. Checkout this repo (using `git clone https://github.com/Polymer/docs.git --recursive`) and make your edits.

1. To build the docs, run `grunt` in base of the docs diretory you checked out. This starts up jekyll and watches for changes as you make edits. You may need to run `npm install` in your docs directory if it's a new checkout.

1. Lastly, fire up the App Engine dev server in this folder (`dev_appserver.py .`) to preview the docs.

Jekyll generates the static site in a folder named `_site`. **Note**: If you're not running jekyll to rebuild the site, you won't see your changes in the dev server.

Once your changes look good, `git commit` them and push.

## Building and pushing the docs

**Note**: only project owners can publish the documentation.

Make sure your `docs/polymer` submodule is up to date

(this should only be necessary when `polymer` merges the *master* -> *stable* branch):

    git submodule update --recursive

Generate the docs using:

    grunt jekyll:prod

Last step is to push the docs to App Engine. In your `Polymer/docs` directory, run:

    appcfg.py update .

[jekyll]: http://jekyllrb.com/

[grunt]: http://gruntjs.com/