JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 103
  • Score
    100M100P100Q78145F
  • License MIT

Automated build tool to update and push vue-cli projects to gh-pages

Package Exports

  • vue-gh-pages

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vue-gh-pages) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

npm version Percentage of issues still open license

vue-gh-pages

Since I could not find a clean way of deploying vue-cli apps to github pages, I made this one.

Step 1: Install the module:

npm install --save-dev vue-gh-pages

Alternatively, with yarn:

yarn add vue-gh-pages

Step 2: Add the following to the script section of your package.json:

"deploy": "node ./node_modules/vue-gh-pages/index.js"

Step 3: Add homepage field to your package.json file:

This will automatically push your builds to github.

"homepage": "https://github.com/myusername/my-app",

If you are using ssh you will need to add the ssh link instead:

"homepage": "git@github.com:myusername/my-app

If this is left off you will have to commit and push the changes manually.

Step 4: Now when you're ready to push to github, run:

npm run deploy

This will create an optimized production build of your project ready for github pages.

Step 5: Finally, if this is your first commit to gh-pages, go to your repository's settings on github, scroll down to the gh-pages section and change the source to:

master branch /docs folder

If you get any errors about filename lengths, run the following command:

(May need administrator privileges)

git config --system core.longpaths true

This may happen as a result of node_modules filenames being overly verbose.

That's it!

Note

If you'd like to try the version using async/await you can install with vue-gh-pages@beta

It should be less fragile than the current build, but I still need to test and I'm not sure when to break applications on older versions of node.