Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vwochnik/jekyll-deploy
Jekyll 3.0-compatible deploy plugin
https://github.com/vwochnik/jekyll-deploy
Last synced: about 1 month ago
JSON representation
Jekyll 3.0-compatible deploy plugin
- Host: GitHub
- URL: https://github.com/vwochnik/jekyll-deploy
- Owner: vwochnik
- License: mit
- Created: 2015-11-24T19:47:16.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2019-12-01T13:09:57.000Z (about 5 years ago)
- Last Synced: 2024-04-24T16:19:27.802Z (8 months ago)
- Language: Ruby
- Size: 6.84 KB
- Stars: 34
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-jekyll-plugins - **Deploy** - deploy](https://rubygems.org/gems/jekyll-deploy)) -- adds a `deploy` command (Upload & Deploy)
README
# Jekyll Deploy [![Gem Version](https://badge.fury.io/rb/jekyll-deploy.png)](http://badge.fury.io/rb/jekyll-deploy)
> Jekyll 3.0-compatible deploy plugin
Jekyll Deploy is a Jekyll plugin which adds a `deploy` sub-command to the `jekyll` executable which allows deploy commands to be executed quickly.
## Installation
This plugin is available as a [RubyGem][ruby-gem].
Add this line to your application's `Gemfile`:
```ruby
group :jekyll_plugins do
gem 'jekyll-deploy'
end
```And then execute the `bundle` command to install the gem.
After the plugin has been installed successfully, the `deploy` sub-command is available for use.
# Configuration
The `deploy` command executes all commands specified in the `deploy` array inside the site's configuration file as the following example demonstrates:
```yaml
deploy:
- rsync -aze ssh --delete ./ example.com:www/
```All commands are executed individually within the site's destination directory which is, by default, `_site` but can be changed with the `destination` configuration option.
The `deploy` sub-command supports the built-in `--config`, `--destination` and `--verbose` command line options.
Simply execute `jekyll deploy` after the site has been built with `jekyll build` or `jekyll serve`.
# Contribute
Fork this repository, make your changes and then issue a pull request. If you find bugs or have new ideas that you do not want to implement yourself, file a bug report.
# Copyright
Copyright (c) 2015 Vincent Wochnik.
License: MIT
[ruby-gem]: https://rubygems.org/gems/jekyll-deploy