README.md

SPA github pages cli

A cli tool for spa-github-pages. It can help you host single page apps with GitHub Pages.

• SPA github pages cli
  • Installation
  • Basic Usage
  • Advance Usage
  • Contributing
  • Contributors

Installation

# npm
npm install --save spa-github-pages-cli --dev

# yarn
yarn add spa-github-pages-cli --dev

Basic Usage

Add to your npm script:

"spa-github-pages": "spa-github-pages",

Run npm script:

// yarn
yarn spa-github-pages

// npm
npm run spa-github-pages

Advance Usage

Set the folder's name that contains index.html. (The default value is docs)

"spa-github-pages": "spa-github-pages -d 'your_custom_folder'",

Set customDomain to true if you are using a custom domain. (The default value is false)

"spa-github-pages": "spa-github-pages -c",

Contributing

1. Fork it (https://github.com/nerdmax/spa-github-pages-cli/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

Contributors

Max Liu 💻 📖 🚇 ⚠️

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!