README.md in jekyll-swift-theme-0.1.1 vs README.md in jekyll-swift-theme-0.2.0
- old
+ new
@@ -1,7 +1,10 @@
-# Jekyll Swift Theme
+
+
+[](https://badge.fury.io/rb/jekyll-swift-theme)
+
This theme is designed for blogging purposes. Feel free to extend it for other use cases though.
At its core, it's minimalistic; it doesn't rely on monolithic libraries such e.g jquery, bootstrap. Instead, it uses grid css, flexbox & vanilla js to facilitate the `features` outlined below:
This Theme is a port of [Hugo Swift Theme](https://github.com/onweru/hugo-swift-theme) for Jekyll. Original credit for this theme goes to [weru](https://github.com/onweru).
@@ -12,15 +15,52 @@
* Blog
* Pagination
* Dark Mode
* Native lazy loading of images
+* Picture & Gallery Support
+* YouTube Video Support
### TODO
* Syntax Highlighting
-* Gallery & Video Support
* Staticman
+* Tag Sites
+
+### Pictures
+
+You can include pictures very simple. You want to use darkmode images when darkmode is enabled on a device and a regular image on lightmode? It takes 3 include parameters
+
+```ruby
+{% include shorts/picture.html normalPath="images/read.jpg" darkPath="images/speakers.jpg" alt="reading" %}
+```
+
+### Gallery
+
+You can include a gallery in your article. For this you need first to define the gallery with its images in the file `_data/gallery.yml`.
+
+```yaml
+example:
+ - image: fast-lane.jpg
+ description: a fast lane
+
+ - image: stuck.jpg
+ description: a stuck bike
+```
+
+Then you can include the gallery with the used key.
+
+```ruby
+{% include shorts/gallery.html name="example" %}
+```
+
+### YouTube Video Support
+
+You can include a youtube video very simple.
+
+```ruby
+{% include shorts/youtube.html videoId="mgiWeQI0_nM" %
+```
## Installation
Add this line to your Jekyll site's `Gemfile`:
\ No newline at end of file