https://github.com/julianrubisch/bridgetown-avatar

Simple port of jekyll-avatar
https://github.com/julianrubisch/bridgetown-avatar

Last synced: 10 days ago
JSON representation

Simple port of jekyll-avatar

• Host: GitHub
• URL: https://github.com/julianrubisch/bridgetown-avatar
• Owner: julianrubisch
• License: mit
• Created: 2021-01-04T10:05:38.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-01-04T10:14:05.000Z (almost 4 years ago)
• Last Synced: 2024-12-12T14:34:31.830Z (15 days ago)
• Language: Ruby
• Size: 797 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Bridgetown-Avatar

very simple port of [Jekyll Avatar](https://github.com/benbalter/jekyll-avatar)

## Installation

Run this command to add this plugin to your site's Gemfile:

```shell

$ bundle add bridgetown-avatar -g bridgetown_plugins

```

## Usage

```liquid

{% avatar github %}

```

or assign the user in a variable:

```liquid

{% assign user=github %}

{% avatar %}

```

Specify a size:

```liquid

{% 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

1. Fork it (https://github.com/username/my-awesome-plugin/fork)

2. Clone the fork using `git clone` to your local development machine.

3. Create your feature branch (`git checkout -b my-new-feature`)

4. Commit your changes (`git commit -am 'Add some feature'`)

5. Push to the branch (`git push origin my-new-feature`)

6. 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](https://rubygems.org) and [NPM](https://www.npmjs.com) 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](https://www.bridgetownrb.com/docs/community)

where friendly folks are standing by to help you build and release your plugin or theme.