bridgetown-avatar
v0.1.1
Published
very simple port of [Jekyll Avatar](https://github.com/benbalter/jekyll-avatar)
Downloads
3
Readme
Bridgetown-Avatar
very simple port of Jekyll Avatar
Installation
Run this command to add this plugin to your site's Gemfile:
$ bundle add bridgetown-avatar -g bridgetown_plugins
Usage
{% avatar github %}
or assign the user in a variable:
{% assign user=github %}
{% avatar %}
Specify a size:
{% avatar github size=128 %}
Testing
- Run
bundle exec rspec
to run the test suite - Or run
script/cibuild
to validate with Rubocop and test with rspec together.
Contributing
- Fork it (https://github.com/username/my-awesome-plugin/fork)
- Clone the fork using
git clone
to your local development machine. - Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
Releasing (you can delete this section in your own plugin repo)
To release a new version of the plugin, simply bump up the version number in both version.rb
and
package.json
, and then run script/release
. This will require you to have a registered account
with both the RubyGems.org and NPM registries.
You can optionally remove the package.json
and frontend
folder if you don't need to package frontend
assets for Webpack.
If you run into any problems or need further guidance, please check out our Bridgetown community resources where friendly folks are standing by to help you build and release your plugin or theme.