jekyll-twitter-theme 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ea0aad43e8b4ff314d4263becedec02e3b0c54200e0bc57bb7f6f6a53f286d2
-  data.tar.gz: 460228b493d5c1460b8c7bad19ee3cadeee13b21ab430aa98cd5d6a6aeb77c0e
+  metadata.gz: '058fe07683c1ede02dcdde4a255c51abc7f265a7afd7e6ec97ecddbc73a45033'
+  data.tar.gz: cdabad6983ba18fd3bb70237fb323b203ff8f06c09b39fa6866de2cbe36d0f48
 SHA512:
-  metadata.gz: b9ac1a0b167d43b749342e2519c5b4c6aebd1bf445cfeb1675b267d26405962f3b8fc386e8ff3e68b6ceea1e143b890efd5f9a10a78b43de8edaa6e6420bea46
-  data.tar.gz: 77d05d3e7b90012cada61f4fe800bc092ba2d91db81220f552ee46aa711120bcd951dc37019311fd09e4720b3b06ec60182bbcb2c29859b1c7c8936b3d7cf4e4
+  metadata.gz: 836418f9e0215150269f7b9eb5ad93a842a4a0e3742354a26bed17415003beed4523b9973142b066103ace1512c4bab25754f07ee5cfcf951f66484da44d76bb
+  data.tar.gz: 2da7cbe80b12d30ffc1e718f02c677a96e9404c26b1e828d11ed8fe31eefc36a861b02c734d43ecf24d1b52f744aabb92957631c085beb356ee770614a8483aa

data/README.md

@@ -1,9 +1,72 @@
 ![IMAGE](image.png)
 
+<p align="center">
+  <img src="https://img.shields.io/gem/v/jekyll-twitter-theme?style=for-the-badge">
+  <img src="https://img.shields.io/github/license/kkent030315/jekyll-twitter-theme?style=for-the-badge">
+  <img src="https://img.shields.io/travis/kkent030315/jekyll-twitter-theme?style=for-the-badge">
+  <img src="https://img.shields.io/badge/DEMO-AVAILABLE-%23008000?style=for-the-badge">
+</p>
+
 [Demo](https://www.godeye.club/jekyll-twitter-theme/)
 
 # jekyll-twitter-theme
 
 A twitter theme for Jekyll.
 
-> This project is `WIP` so please use at your own risk.
+# Usage
+
+1. Install [Jekyll](https://jekyllrb.com/docs/step-by-step/01-setup/)
+
+2. Install theme:
+
+```sh
+$ gem install jekyll-twitter-theme
+```
+
+3. In `_config.yml`:
+
+```yml
+# Build settings
+theme: jekyll-twitter-theme
+```
+
+4. launch on local as development:
+
+```sh
+$ bundle exec jekyll serve
+```
+
+# Responsive
+
+This theme is responsive for every single environments.
+
+(`iPad (left)`, `iPhoneX (right)`)
+
+![Responsive](/assets/images/jekyll-twitter-theme-responsive.png)
+
+# Configurations
+
+There are some theme-specific configurations as follows:
+
+```yml
+global:
+  # site icon should have 1:1 aspect ratio
+  site_icon: "<site icon shown in left-top of the page>"
+  nav:
+    caption_home: "Home"
+  profile:
+    image:
+      url: "<url of your profile image>"
+    name: "Jekyll Blog"
+    id: "@jekyll_blog"
+  post:
+    default_thumbnail: "<default thumbnail of the post>"
+  twitter:
+    show_twitter_embed_timeline: true
+    target_id: "<twitter id that you desired to show timeline on the right side of the page>"
+    limit: 5
+```
+
+# Issues
+
+Having issues with this theme? Don't heistate to [Create New Issue](https://github.com/kkent030315/jekyll-twitter-theme/issues) :)

data/_config.yml

@@ -5,7 +5,6 @@ description: A twitter theme for Jekyll.
 global:
   # site icon should have 1:1 aspect ratio
   site_icon: "https://avatars3.githubusercontent.com/u/3083652?s=200&v=4"
-  base_url: ""
   nav:
     caption_home: "Home"
   profile:

data/_sass/_main.scss

@@ -287,6 +287,7 @@ main {
     position: sticky;
     top: 0;
     width: 100%;
+    max-width: 100%;
     min-height: 60px;
     border-bottom: 1px solid $color-border;
     border-right: 1px solid $color-border;
@@ -298,12 +299,15 @@ main {
         border-right: 0;
     }
     .content-title {
+        margin-right: 4px;
         font-size: 19px;
         font-weight: bold;
+        @include elipse_force();
     }
     .content-date {
         color: $color-font-thin;
         margin: 0 0 0 auto;
+        white-space: nowrap;
     }
     .back-icon {
         cursor: pointer;
@@ -314,6 +318,7 @@ main {
         border-radius: 50%;
         width: 39px;
         height: 39px;
+        transition: .2s ease;
         &:hover {
             background: rgba($color-primary, 0.15);
         }

data/_sass/_mixins.scss

@@ -43,6 +43,15 @@
     -ms-overflow-style: none; // IE, Edge
     scrollbar-width: none; // Firefox
     &::-webkit-scrollbar {
-        display:none; // Chrome, Safari
+        display: none; // Chrome, Safari
     }
 }
+
+@mixin elipse_force() {
+    display: inline-block;
+    white-space: nowrap;
+    overflow: hidden;
+    text-overflow: ellipsis;
+    -webkit-text-overflow: ellipsis;
+    -o-text-overflow: ellipsis;
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-twitter-theme
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - kento
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2020-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,7 +52,14 @@ files:
 - _sass/_variables.scss
 - assets/css/main.scss
 - assets/css/ress.min.css
+- assets/images/beach.jpg
+- assets/images/jekyll-twitter-theme-responsive-ipad-body.png
+- assets/images/jekyll-twitter-theme-responsive-ipad.png
+- assets/images/jekyll-twitter-theme-responsive-iphone-x-body.png
+- assets/images/jekyll-twitter-theme-responsive-iphone-x.png
+- assets/images/jekyll-twitter-theme-responsive.png
 - assets/images/markdown.png
+- assets/images/octojekyll.png
 homepage: https://github.com/kkent030315/jekyll-twitter-theme
 licenses:
 - MIT