Skip to content

Latest commit

 

History

History
74 lines (45 loc) · 3.07 KB

README.md

File metadata and controls

74 lines (45 loc) · 3.07 KB
Raw

vue-cli-plugin-gh-pages

Latest Version on NPM Software License Known Vulnerabilities

Vue CLI plugin to publish to GitHub pages (or any other branch anywhere else).

⚠️ Vue CLI and this plugin are in Maintenance Mode! ⚠️

For new projects, it is now recommended to use create-vue to scaffold Vite-based projects. Also refer to the Vue 3 Tooling Guide for the latest recommendations. You can use the gh-pages CLI as a replacement for this plugin.

Install

vue add gh-pages

N.B. This plugin requires Git >=1.9.

Usage

npm run gh-pages

The generator automatically adds this script, however, you are free to modify this.

Options

This package is a wrapper around gh-pages, so the same options apply to this package. Please see the documentation of gh-pages for a list of supported options. These options must be defined in vue.config.js under pluginOptions.ghPages e.g.

module.exports = {
    pluginOptions: {
        ghPages: {
            message: 'Updates',
        },
    },
};

All options can also be set using the Vue CLI UI. In addition, most options can also be defined on the command line. Please run npm run gh-pages -- --help to see a list of supported CLI options.

Functions

The message and tag options can be a function and their return value will be used. This allows you to create, for example, time based commit messages or create a tag based on certain information.

N.B. When these options are defined as a function, they can not be edited using the Vue CLI UI!

Changelog

Please see CHANGELOG for more information about what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please contact Jasper Zonneveld directly or report to NPM instead of using the issue tracker.

License

The MIT License (MIT). Please see License File for more information.

This package is not affiliated with nor endorsed by GitHub. GitHub is a registered trademark of GitHub Inc.

Credits

This package is a Vue CLI plugin wrapping gh-pages. Many thanks to Tim Schaub for his excellent package!