gh-pages-spa

gh-pages-spa copied to clipboard

This is a tiny package to enable building Single Page Applications for GitHub Pages.

Live demo

Getting Started

Use the template provided in the example folder or, follow the easy steps below,

1- Create a new project with two pages index.html and 404.html.

2- Install this package with either Bower or NPM,

npm install ghspa

3- Include file ghspa.js in each page, as follows,

<script type="text/javascript" src="path-to/ghspa.js"></script>

4- Set 404.html page title to 404, as follows,

<title>404</title>

5- This package supports the two types of GitHub Pages, User/Organization and Project Pages. The global parameter projectPages is set to window.projectPages || true which will be always true by default for Project Pages. To enable User/Organization Pages or Custom Domains change the parameters in ghspa.js from window.projectPages || true to false,

Credits

This project was built with these resources,

SPA Github Pages, host single page apps with github pages.

Pokemon Go, a free SVG icon set.

Semantic-UI, a development framework that helps create beautiful, responsive layouts using human-friendly HTML.

License

MIT license Copyright (c) Web Semantics, Inc.