Narcoleptic Pony Machine

    spa-github-pages-cli
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.2 • Public • Published

    SPA github pages cli

    Greenkeeper badge styled with prettier Commitizen friendly All Contributors

    NPM Version License Stats Downloads Stats Github stars Github issues Build Status codecov Dev Dependencies

    Donate

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

    nodei.co

    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!

    Install

    npm i spa-github-pages-cli

    DownloadsWeekly Downloads

    8

    Version

    1.2.2

    License

    MIT

    Unpacked Size

    47.2 kB

    Total Files

    13

    Last publish

    Collaborators

    • nerdmax