jekyll-theme-fos 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78196d2a7201a17a9da8b09c562b3f3c08d6b2486c69a240bd6fb9452fc8a159
+  data.tar.gz: 433c9f4b1f3cb8d6bc15c3462a4e9e4d6d8e60ee36da1e6594254214024399ca
+SHA512:
+  metadata.gz: 5b37db62cd51f535fb936ff8fd238550e030387b15322ad2d1c2a7095b357d1ef3cc79646dcccaf3b1686d80e8707e88ae44e0234065a7fc128fb59eca76a91a
+  data.tar.gz: bf08759ae5d682d6f6990fa1fe2a80e8eecac373542c07dd1efbd8c9d0d114dd159f905741d96c32450f20e4b7f45338b9cee6f905aed77f410d220be8919a77

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Fahim Farook
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# jekyll-theme-fos
+
+A [Tufte](https://www.edwardtufte.com/tufte/) inspired, carefully crafted theme with a focus on simplicity.
+
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-theme-fos"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-theme-fos
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-theme-fos
+
+## Configurations
+See the following example configuration files.
+- [_config.yml](_config.yml)
+- [_data/analytics.yml](_data/analytics.yml)
+- [_data/comments.yml](_data/comments.yml)
+- [_data/navigation.yml](_data/navigation.yml)
+- [_data/posts.yml](_data/posts.yml)
+- [_data/social-networks.yml](_data/social-networks.yml)
+- [_data/theme.yml](_data/theme.yml)
+
+## Usage
+
+This theme has a couple of layouts - `post`, and `page`. `post` layout is what you use for blog posts and pages such as index.html, about.html etc. are based on `page` layout.
+
+Copy sample index, about, 404 and post pages from sample directory:
+- [index.html](samples/index.html)
+- [about.md](samples/about.md)
+- [atom.xml](samples/atom.xml)
+- [tags.html](samples/tags.html)
+- [404.html](samples/404.html)
+- [CNAME](samples/CNAME)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hello. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Development
+
+To set up your environment to develop this theme, run `bundle install`.
+
+Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
+
+When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
+To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-fos.gemspec` accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/_config.yml

@@ -0,0 +1,47 @@
+# url settings
+url: "www.yoursite.com"
+baseurl: "" # the subpath of your site, e.g. /blog
+
+# site details
+author: &author Your Name
+title: "Your Title"
+description: "Your Tagline" 
+image: &image "/img/avatar.png"
+language: en-us
+
+# defauls
+defaults:
+  - scope:
+      path: ""
+      type: "posts"
+    values:
+      layout: "post"
+      comments: true
+      page-share: true
+  - scope:
+      path: ""
+    values:
+      layout: "page"
+      author: *author
+      image: *image
+
+# build settings
+theme: jekyll-theme-fos
+markdown: kramdown
+plugins:
+  - jekyll-feed
+  - jekyll-paginate
+  - jekyll-sitemap
+  - jekyll-remote-theme
+
+# excludes
+exclude:
+  - CHANGELOG.md
+  - CNAME
+  - Gemfile
+  - Gemfile.lock
+  - LICENSE
+  - README.md
+
+# number of post previews index.html
+paginate: 3

data/_data/analytics.yml

@@ -0,0 +1,6 @@
+
+google:
+  tracking-id: UA-131770820-1
+  tag-manager-id: GTM-NHND6JH
+facebook:
+  app-id: 787792301572824

data/_data/comments.yml

@@ -0,0 +1,4 @@
+disqus:
+  site: "disqus-sub-domain"
+  show-count: true
+  

data/_data/navigation.yml

@@ -0,0 +1,5 @@
+Home: "/"
+About me: "/about"
+Projects: "/projects"
+Talks: "/talks"
+Browse tags: "/tags"

data/_data/posts.yml

@@ -0,0 +1 @@
+summary-length: 50

data/_data/social-networks.yml

@@ -0,0 +1,67 @@
+email:
+  title: Email
+  icon: "fi fi-email"
+  url: "mailto:you@yourdomain.me"
+  username: "you@yourdomain.me"
+
+github:
+  title: "GitHub"
+  icon: "fi fi-github"
+  url: "https://github.com/your-handle"
+  username: "your-handle"
+
+stackoverflow:
+  title: "StackOverflow"
+  icon: "fi fi-stack-overflow"
+  url: "https://stackoverflow.com/users/your-id/your-handle"
+  username: "your-handle"
+
+linkedin:
+  title: "LinkedIn"
+  icon: "fi fi-linkedin"
+  url: "https://linkedin.com/in/your-handle"
+  username: "your-handle"
+  share-url: "https://www.linkedin.com/shareArticle?mini=true&url="
+
+twitter:
+  title: "Twitter"
+  icon: "fi fi-twitter"
+  url: "https://twitter.com/your-handle"
+  username: "your-handle"
+  share-url: "https://twitter.com/intent/tweet?text="
+
+google-plus:
+  title: "Google Plus"
+  icon: "fi fi-google-plus"
+  share-url: "https://plus.google.com/share?url="
+
+facebook:
+  title: "Facebook"
+  icon: "fi fi-facebook"
+  share-url: "https://www.facebook.com/sharer/sharer.php?u="
+
+reddit:
+  title: "Reddit"
+  icon: "fi fi-reddit"
+  share-url: "http://reddit.com/submit?url="
+
+feed:
+  title: "Feed"
+  url: "/atom.xml"
+  icon: "fi fi-rss"
+  username:
+
+links:
+  - email
+  - github
+  - stackoverflow
+  - linkedin
+  - twitter
+  - feed
+
+page-share:
+  - linkedin
+  - twitter
+  - facebook
+  - google-plus
+  - reddit

data/_data/theme.yml

@@ -0,0 +1,17 @@
+font:
+  href:
+    - "/assets/css/fonts.css"
+  brand: "'Helvetica Neue', Helvetica, sans-serif"
+  header: "et-book" 
+  body: "et-book"
+  code: "Monaco, Consolas, sans-serif"
+  numeral: "et-book-roman-old-style"
+
+color:
+  black: "#404040"
+  white: "#FFFFFF"
+  grey: "#8D8D8D"
+  primary: "#9C5284"
+  secondary: "#FFFFF8"
+
+  

data/_includes/body-end.html

@@ -0,0 +1,12 @@
+<!-- scripts -->
+{%- if layout.js -%}
+    {%- for href in layout.js -%}
+        <script src="{{- href -}}" /></script>
+    {%- endfor -%}
+{%- endif -%}
+
+{%- if page.js -%}
+    {%- for href in page.js -%}
+        <script src="{{- href -}}" /></script>
+    {%- endfor -%}
+{%- endif -%}

data/_includes/body-start.html

@@ -0,0 +1 @@
+{%- include google-tm-body.html -%}

data/_includes/comments.html

@@ -0,0 +1,5 @@
+{%- if page.comments -%}
+    <section class="fos-comments">
+        {%- include disqus.html -%}
+    </section>
+{%- endif -%}

data/_includes/copyright.html

@@ -0,0 +1,3 @@
+<p class="fos-copyright">
+    &copy;&nbsp;{{- site.author -}}&nbsp;{{- site.time | date: "%Y" -}}
+</p>

data/_includes/date.html

@@ -0,0 +1 @@
+<p class="fos-posted-date">{{- include.date | date: "%B %d, %Y" -}}</p>

data/_includes/disqus.html

@@ -0,0 +1,28 @@
+{%- if site.data.comments.disqus -%}
+
+    <div id="disqus_thread"></div>
+    <script>
+
+    /**
+    *  RECOMMENDED CONFIGURATION VARIABLES: EDIT AND UNCOMMENT THE SECTION BELOW TO INSERT DYNAMIC VALUES FROM YOUR PLATFORM OR CMS.
+    *  LEARN WHY DEFINING THESE VARIABLES IS IMPORTANT: https://disqus.com/admin/universalcode/#configuration-variables*/
+    /*
+    var disqus_config = function () {
+    this.page.url = PAGE_URL;  // Replace PAGE_URL with your page"s canonical URL variable
+    this.page.identifier = PAGE_IDENTIFIER; // Replace PAGE_IDENTIFIER with your page"s unique identifier variable
+    };
+    */
+    (function() { // DON"T EDIT BELOW THIS LINE
+    var d = document, s = d.createElement("script");
+    s.src = "https://{{- site.data.comments.disqus.site -}}.disqus.com/embed.js";
+    s.setAttribute("data-timestamp", +new Date());
+    (d.head || d.body).appendChild(s);
+    })();
+    </script>
+    <noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+                            
+    {%- if site.data.comments.disqus.show-count -%}
+        <script id="dsq-count-scr" src="//{{- site.data.comments.disqus.site -}}.disqus.com/count.js" async></script>
+    {%- endif -%}
+
+{%- endif -%}

data/_includes/facebook-og.html

@@ -0,0 +1,10 @@
+{%- if site.data.analytics.facebook.app-id -%}
+    <meta property="fb:app_id" content="{{- site.data.analytics.facebook.app-id -}}" />
+{%- endif -%}
+
+<meta property="og:type" content="website" />
+<meta property="og:locale" content="{{- site.language -}}" />
+<meta property="og:title" content="{{- page.title -}}" />
+<meta property="og:description" content="{{- page.description -}}">
+<meta property="og:url" content="{{- site.url -}}{{- page.url -}}" />
+<meta property="og:image" content="{{- site.url -}}{{- page.image -}}" />

data/_includes/footer.html

@@ -0,0 +1,8 @@
+<footer class="fos-footer row">
+	<div class="col-12 d-flex justify-content-center">
+		{%- include social-icons.html -%}
+	</div>
+	<div class="col-12 d-flex justify-content-center">
+		{%- include copyright.html -%}
+	</div>
+</footer>

data/_includes/google-tm-body.html

@@ -0,0 +1,11 @@
+{%- if site.data.analytics.google.tag-manager-id -%}
+    <!-- google tag manager (noscript) -->
+    <noscript>
+        <iframe src="https://www.googletagmanager.com/ns.html?id={{- site.data.analytics.google.tag-manager-id -}}"
+                height="0" 
+                width="0" 
+                style="display:none;visibility:hidden">
+        </iframe>
+    </noscript>
+    <!-- end google tag manager (noscript) -->
+{%- endif -%}

data/_includes/google-tm-gtag.html

@@ -0,0 +1,12 @@
+{%- if site.data.analytics.google.tracking-id -%}
+  <!-- global site tag (gtag.js) - google analytics -->
+  <script async src="https://www.googletagmanager.com/gtag/js?id={{- site.data.analytics.google.tracking-id -}}"></script>
+  <script>
+    window.dataLayer = window.dataLayer || [];
+    function gtag(){dataLayer.push(arguments);}
+    gtag("js", new Date());
+
+    gtag("config", "{{- site.data.analytics.google.tracking-id -}}");
+  </script>
+{%- endif -%}
+

data/_includes/google-tm-head.html

@@ -0,0 +1,11 @@
+{%- if site.data.analytics.google.tag-manager-id -%}
+    <!-- google tag manager -->
+    <script>
+    (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({"gtm.start":
+    new Date().getTime(),event:"gtm.js"});var f=d.getElementsByTagName(s)[0],
+    j=d.createElement(s),dl=l!="dataLayer"?"&l="+l:"";j.async=true;j.src=
+    "https://www.googletagmanager.com/gtm.js?id="+i+dl;f.parentNode.insertBefore(j,f);
+    })(window,document,"script","dataLayer","{{- site.data.analytics.google.tag-manager-id -}}");
+    </script>
+    <!-- end google tag manager -->
+{%- endif -%}

data/_includes/head.html

@@ -0,0 +1,40 @@
+<meta charset="utf-8" />
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+<meta name="author" content="{{- page.author -}}" />
+<meta name="description" content="{{- page.description -}}">
+<meta name="keywords" content="{{- page.author -}}, {{- page.title -}}, {{- page.description -}}" />
+{%- include facebook-og.html -%}
+{%- include twitter-summary.html -%}
+
+{%- assign title = site.title -%}
+{%- unless title -%}
+    {%- assign title = page.title -%}
+{%- endunless -%}
+<title>{{- title -}}</title>
+
+<link rel="alternate" type="application/rss+xml" href="{{- site.baseurl -}}atom.xml" />
+
+<!-- stylesheets -->
+{%- if layout.css -%}
+    {%- for href in layout.css -%}
+        <link rel="stylesheet" href="{{- href -}}" />
+    {%- endfor -%}
+{%- endif -%}
+
+{%- if page.css -%}
+    {%- for href in page.css -%}
+        <link rel="stylesheet" href="{{- href -}}" />
+    {%- endfor -%}
+{%- endif -%}
+
+<!-- fonts -->
+{%- if site.data.theme.font.href -%}
+    {%- for href in site.data.theme.font.href -%}
+        <link rel="stylesheet" href="{{- href -}}">
+    {%- endfor -%}
+{%- endif -%}
+
+<!-- analytics -->
+{%- include google-tm-gtag.html -%}
+{%- include google-tm-head.html -%}

data/_includes/image.html

@@ -0,0 +1,8 @@
+<figure>
+    {%- if include.description -%}
+    <img src="{{- include.src -}}" alt="{{- include.description -}}" style="{{- include.style -}}">
+    <figcaption>{{- include.description -}}</figcaption>
+    {%- else -%}
+    <img src="{{- include.src -}}" style="{{- include.style -}}">
+    {%- endif -%}
+</figure>

data/_includes/menu-icon.html

@@ -0,0 +1,5 @@
+  <div class="fos-menu-icon">
+    <span></span>
+    <span></span>
+    <span></span>
+  </div>

data/_includes/meta.html

@@ -0,0 +1,5 @@
+<section class="fos-post-meta">
+    {%- include date.html date=page.date -%}
+    {%- include tags.html -%}
+    {%- include share.html -%}
+</section>

data/_includes/navigation.html

@@ -0,0 +1,15 @@
+<div class="fos-navigation container-fluid d-flex justify-items-center align-items-center p-0 m-0">
+  {%- include menu-icon.html -%}
+
+  <div class="container">
+    <div class="row">
+      {%- if site.data.navigation -%}
+      <nav class="col-12 col-md-4 d-flex flex-row flex-md-column flex-wrap align-items-start justify-content-center">
+        {%- for nav in site.data.navigation -%}
+        <a href="{{- nav[1] -}}">{{- nav[0] -}}</a>
+        {%- endfor -%}
+      </nav>
+      {%- endif -%}
+    </div>
+  </div>
+</div>