Commit 36b2064e authored by Jan-Philipp Stauffert's avatar Jan-Philipp Stauffert
Browse files

Write Readme

parent 0cf8d45e
# Jekyll Img Srcset
This plugin resizes images to offer lower resolution images for devices with restricted screen size such as mobile.
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "jekyll-img-srcset", :git => "git@gitlab2.informatik.uni-wuerzburg.de:hci-development/jekyll-img-srcset.git"
```
And add these lines to your Jekyll site's `_config.yml`:
```yaml
plugins:
- jekyll-img-srcset
```
Then execute:
$ bundle
Or install it yourself as:
$ gem install hci-theme
## Usage
There are two ways to use this plugin. It tries to convert all Markdown image tags and offers a liquid tag for use in HTML content:
```markdown
![caption text](url "alt text"){.class style="color: black;"}
```
```
{% imgsrcset src="general/map.jpg" dimension="wide" %}
```
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment