Files
polymer-starter-kit/docs/deploy-to-github-pages.md
Rohan Verma 31bf678e26 Modified documentation and readme to reduce confusion in the example for deploying to github
This change reduces confusion about using backslashes or not in the URL and is generally more helpful to new comers.
2016-03-14 00:35:28 +05:30

33 lines
1.3 KiB
Markdown

# Deploy to Github Pages
You can deploy to github pages with a couple minor changes to Polymer Starter Kit:
1. Uncomment this line `// app.baseUrl = '/polymer-starter-kit/';` in app.js near the top
```JavaScript
// Sets app default base URL
app.baseUrl = '/';
if (window.location.port === '') { // if production
// Uncomment app.baseURL below and
// set app.baseURL to '/your-pathname/' if running from folder in production
// app.baseUrl = '/polymer-starter-kit/';
}
```
2. Change `app.baseUrl = '/polymer-starter-kit/';` to `app.baseUrl = '/your-pathname/';` (ex: if you repo is `github.com/username/bobs-awesome-site` you would change this to `app.baseUrl = '/bobs-awesome-site/';`)
3. Add this code at the top of `<head>` tag in the [index.html](../app/index.html) to force HTTPS:
```html
<script>'https:'!==window.location.protocol&&(window.location.protocol='https')</script>
```
4. Run `gulp build-deploy-gh-pages` from command line
5. To see changes wait 1-2 minutes then load Github pages for your app (ex: https://polymerelements.github.io/polymer-starter-kit)
### Notes
* When deploying to Github Pages we recommend using hashbangs which is Polymer Starter Kit default.
* This method should work for most hosting providers when using a subfolder.