{"id":18060350,"url":"https://github.com/unbug/polymer-old-doc","last_synced_at":"2025-04-05T12:14:58.458Z","repository":{"id":19134045,"uuid":"22363804","full_name":"unbug/polymer-old-doc","owner":"unbug","description":null,"archived":false,"fork":false,"pushed_at":"2014-07-29T01:39:22.000Z","size":12384,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-10T23:35:11.551Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unbug.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-29T01:36:38.000Z","updated_at":"2014-07-29T01:39:26.000Z","dependencies_parsed_at":"2022-08-30T12:00:46.805Z","dependency_job_id":null,"html_url":"https://github.com/unbug/polymer-old-doc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unbug%2Fpolymer-old-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unbug%2Fpolymer-old-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unbug%2Fpolymer-old-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unbug%2Fpolymer-old-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unbug","download_url":"https://codeload.github.com/unbug/polymer-old-doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247332596,"owners_count":20921854,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-31T04:07:51.921Z","updated_at":"2025-04-05T12:14:58.437Z","avatar_url":"https://github.com/unbug.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"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.\n\n## Install the requirements\n\nWe 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/)):\n\n    sudo gem install jekyll\n    sudo npm install -g grunt-cli\n    npm install\n\nYou'll also need the App Engine dev server to preview the docs locally. [Download the SDK](https://developers.google.com/appengine/downloads).\n\n## Making edits and previewing changes\n\nThis repo (`polymer/docs`) is where the documentation source files live. To make a change:\n\n1. Checkout this repo (using `git clone https://github.com/Polymer/docs.git --recursive`) and make your edits.\n1. 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.\n1. Lastly, fire up the App Engine dev server in this folder (`dev_appserver.py .`) to preview the docs.\n\nJekyll 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.\n\nOnce your changes look good, `git commit` them and push.\n\n## Building and pushing the docs\n\n**Note**: only project owners can publish the documentation.\n\nMake sure your `docs/polymer` submodule is up to date\n(this should only be necessary when `polymer` merges the *master* -\u003e *stable* branch):\n\n    git submodule update --recursive\n\nGenerate the docs using:\n\n    grunt jekyll:prod\n\nLast step is to push the docs to App Engine. In your `Polymer/docs` directory, run:\n\n    appcfg.py update .\n\n[jekyll]: http://jekyllrb.com/\n[grunt]: http://gruntjs.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funbug%2Fpolymer-old-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funbug%2Fpolymer-old-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funbug%2Fpolymer-old-doc/lists"}