jekyll-theme-open-project 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f63f8643bb9855ad20012177db44becdb80a7778
-  data.tar.gz: 014a60f5e4a78a6cd57dba5044bbc5798d633582
+  metadata.gz: aff4ab4e845908430012fb65710082e1abc2fd21
+  data.tar.gz: 30e4171d77ea0c8c3728c7d45d3212b8ddaaf782
 SHA512:
-  metadata.gz: bf22cfc111dbf66942bc17444d2a196d010a22b87b98d5b1d1a1b52d754c8d8256b0152d6fab11373d02f312fc7465ac0e2d9b893b5cb1de2a2bcc78dcbf7f70
-  data.tar.gz: e14362bc7b7a585be61c3613a7adfa35424f729bdc0386e8e20027c5b2d07ede3f4a2b0cef57fe5ac328ae763e00db278e2066bc5984331fc9b59077c1b645ae
+  metadata.gz: b13b325eb8e0781ddce197c3f55f9639ed8b0923fb3ef3570350e86e71e02a6b12274d6fbe650f28e04ab17f78f4067a75889f457f66e5936a593aaf43bec9ac
+  data.tar.gz: b9722b7db51576cbe2e74bc61983fd891e70fc80d0648d67a04615bbf651b988514c6b96e115071412cbf476ac2e2ae33aae8285a2c8cc53f06e94d91ae7b6f9

data/README.md

@@ -112,14 +112,13 @@ These settings apply to both site types (hub and project).
   # Site’s URL with protocol and without optional www. prefix.
   # Used e.g. for marking external links in docs and blog posts.
 
-  title: Site title
-  description: Site description
+  title: Example
+  description: The example of examples
   # The above two are used by jekyll-seo-tag for things such as
   # `<title>` and `<meta>` tags, as well as elsewhere by the theme.
 
-  tagline: Site tagline
-  pitch: Site pitch
-  # The above two are used in home hero unit.
+  tagline: Because examples are very important
+  # Used in hero unit on main page.
 
   social:
     links:
@@ -131,7 +130,12 @@ These settings apply to both site types (hub and project).
     tos_link: https://www.example.com/tos
     privacy_policy_link: https://www.example.com/privacy
 
-  # These are required for the theme to work:
+  # no_auto_fontawesome: yes
+  # Specify this only if you want to disable free Font Awesome CDN.
+  # IMPORTANT: In this case your site MUST specify include head.html with appropriate scripts.
+  # Theme design relies on Font Awesome “solid” and “brands” icon styles
+  # and expects them to be included in SVG mode.
+  # Without this setting, one-file FA distribution, all.js, is included from free FA CDN.
 
   theme: jekyll-theme-open-project
   permalink: /blog/:month-:day-:year/:title/
@@ -154,10 +158,10 @@ and name as word(s).
   Drop a file called `title.html` in the root of your site.
   In its contents you can go as simple as `{{ site.name }}`
   and as complex as a custom SVG shape.
-  
+
   Note that it must look good when placed inside ~30px tall container.
   In case of SVG, SVG guidelines apply.
-  
+
 Do not create custom CSS rules for .site-logo descendants:
 this may cause issues when one site’s logo is used in context of another site
 of the same hub. You can use inline styling, though.
@@ -255,9 +259,8 @@ must contain a file "index.md" with frontmatter like this:
 
 ```yaml
 title: Sample Awesome Project
-
-description: >-
-  A sentence or two go here.
+description: A sentence or two about what the project is for.
+tagline: Because awesomeness is underrated
 
 # Whether the project is included in featured three projects on hub home page
 featured: true | false
@@ -346,6 +349,7 @@ parent_hub:
 algolia_search:
   api_key: '<your Algolia API key>'
   index_name: '<your Algolia index name>'
+
 # Only add this if you want to use Algolia’s search on your project site.
 
 tag_namespaces:
@@ -508,7 +512,7 @@ external_links:
 #   GitHub, Docs.rs, RubyDoc,
 #   ietf.org/html/rfcN, datatracker.ietf.org/doc/…
 # * Order links according to importance for project site visitors.
-#   The first link will be highlighted as primary. 
+#   The first link will be highlighted as primary.
 
 feature_with_priority: 1
 # With this key, software or spec will be featured on home
@@ -695,7 +699,7 @@ Commonly used layouts are:
 
 ### Page frontmatter
 
-Typical expected page frontmatter is `title` and `description`. Those are 
+Typical expected page frontmatter is `title` and `description`. Those are
 also used by jekyll-seo-tag plugin to add the appropriate meta tags.
 
 Commonly supported in page frontmatter is the hero_include option,
@@ -817,7 +821,7 @@ run `bundle install`.
 
 To experiment with this code, add content (projects, software, specs)
 and run `bundle exec jekyll serve`. This starts a Jekyll server
-using this theme at `http://localhost:4000`. 
+using this theme at `http://localhost:4000`.
 
 Put your layouts in `_layouts`, your includes in `_includes`,
 your sass files in `_sass` and any other assets in `assets`.

data/_config.yml

@@ -41,6 +41,16 @@ collections:
     output: true
     permalink: /:name/
 
+fontawesome_cdn:
+  version: v5.8.1
+  integrity: "sha384-g5uSoOSBd7KkhAMlnQILrecXvzst9TdC09/VM+pjDTCM+1il8RHz5fKANTFFb+gQ" 
+# Only applies if no_auto_fontawesome is not set.
+
+no_auto_fontawesome: false
+# If set to yes, site (with default design) must specify <script> elements
+# that make required FA styles available in SVG mode.
+
+
 defaults:
   - scope:
       path: ""

data/_includes/external-link.html

@@ -10,7 +10,7 @@
 
   {% elsif include.url contains "rubygems.org" %}
     <span class="ico">
-      <i class="far fa-gem"></i>
+      <i class="fas fa-gem"></i>
     </span>
     <span class="lbl">
       {{ include.title | default: "Gem" }}
@@ -18,7 +18,7 @@
 
   {% elsif include.url contains "crates.io/crates" %}
     <span class="ico">
-      <i class="far fa-cubes"></i>
+      <i class="fas fa-cubes"></i>
     </span>
     <span class="lbl">
       {{ include.title | default: "Crate" }}
@@ -26,7 +26,7 @@
 
   {% elsif include.url contains "rubydoc" %}
     <span class="ico">
-      <i class="far fa-gem"></i>
+      <i class="fas fa-gem"></i>
     </span>
     <span class="lbl">
       {{ include.title | default: "RubyDoc" }}
@@ -34,7 +34,7 @@
 
   {% elsif include.url contains "docs.rs" %}
     <span class="ico">
-      <i class="far fa-book"></i>
+      <i class="fas fa-book"></i>
     </span>
     <span class="lbl">
       {{ include.title | default: "Docs.rs" }}

data/_includes/home-hero.html

@@ -8,7 +8,7 @@
   {% if site.is_hub %}
     <div class="cta">
       <a class="button" href="{{ "/projects/" | relative_url }}">
-        <i class="icon far fa-search"></i>
+        <i class="icon fas fa-search"></i>
         Explore Projects
       </a>
     </div>

data/_includes/item-doc-page.html

@@ -47,8 +47,8 @@ supporting expandable navigation widget.
 
       {% if num_top_nav_items > 0 %}
         <span class="nav-toggle-icon">
-          <i class="open far fa-ellipsis-v"></i>
-          <i class="close far fa-times"></i>
+          <i class="open fas fa-ellipsis-v"></i>
+          <i class="close fas fa-times"></i>
         </span>
       {% endif %}
     </div>
@@ -66,7 +66,7 @@ supporting expandable navigation widget.
             <li class="item home-link" title="Documentation index">
               <a href="{{ product_base_url | relative_url }}">
                 <span class="ico">
-                  <i class="far fa-home"></i>
+                  <i class="fas fa-home"></i>
                 </span>
                 <span class="lbl">
                   Home

data/_layouts/default.html

@@ -9,7 +9,14 @@
   <link href="{{ "/assets/webclip.png" | relative_url }}" rel="apple-touch-icon">
 
   <link id="themeCSS" rel="stylesheet" href="{{ "assets/css/style.css" | relative_url }}">
-  <script defer src="https://pro.fontawesome.com/releases/v5.1.0/js/all.js" integrity="sha384-E5SpgaZcbSJx0Iabb3Jr2AfTRiFnrdOw1mhO19DzzrT9L+wCpDyHUG2q07aQdO6E" crossorigin="anonymous"></script>
+
+  {% unless site.no_auto_fontawesome %}
+    <script
+      defer
+      src="https://use.fontawesome.com/releases/{{ site.fontawesome_cdn.version }}/js/all.js"
+      integrity="{{ site.fontawesome_cdn.integrity }}"
+      crossorigin="anonymous"></script>
+  {% endunless %}
 
   {% if site.algolia_search %}
     <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
@@ -28,6 +35,8 @@
   {% endif %}
 
   {% seo %}
+
+  {% include head.html %}
 </head>
 
 {% assign num_projects = site.projects | size %}
@@ -99,14 +108,14 @@
     {% endcomment %}
     <script>
       window.initAlgolia = function () {
-        docsearch({ 
-          apiKey: '{{ site.algolia_search.api_key }}', 
-          indexName: '{{ site.algolia_search.index_name }}', 
-          inputSelector: 'input[type=search]', 
+        docsearch({
+          apiKey: '{{ site.algolia_search.api_key }}',
+          indexName: '{{ site.algolia_search.index_name }}',
+          inputSelector: 'input[type=search]',
           debug: false,
-        }); 
+        });
       };
-    </script> 
+    </script>
   {% endif %}
 
   <script src="{{ "assets/js/headroom.min.js" | relative_url }}"></script>

data/_layouts/docs-base.html

@@ -24,8 +24,8 @@ layout: default
 
     {% if num_top_nav_items > 0 %}
       <span class="nav-toggle-icon">
-        <i class="open far fa-ellipsis-v"></i>
-        <i class="close far fa-times"></i>
+        <i class="open fas fa-ellipsis-v"></i>
+        <i class="close fas fa-times"></i>
       </span>
     {% endif %}
   </div>

data/_sass/jekyll-theme-open-project.scss

@@ -1,4 +1,7 @@
+@import url('https://fonts.googleapis.com/css?family=Inconsolata');
+
 $font-family: Helvetica, Arial, sans-serif !default;
+$font-family-source: Inconsolata, monospace;
 
 $main-font-color: #000;
 
@@ -653,6 +656,7 @@ body.site--project {
           display: flex;
           flex-flow: row nowrap;
           align-items: center;
+          flex-shrink: 0;
 
           .title {
             flex: 1;

data/_sass/open-project-mixins.scss

@@ -25,14 +25,17 @@
 }
 
 @mixin padded-code-snippet() {
-  padding: 0 .75em;
+  padding: .2em .5em;
   margin: 0 .2em;
-  background: $code-listing-background-color;
-
-  border: 1px dashed $code-listing-border-color;
-  border-radius: .25em;
 
   font-size: 15px;
+
+  background: $code-listing-background-color;
+
+  border-color: $code-listing-border-color;
+  border-width: 0 1px 0 1px;
+  border-style: dashed;
+  border-radius: 0;
 }
 
 @mixin padded-code-snippet--reset() {
@@ -74,6 +77,8 @@
   margin-top: -1px;
   margin-bottom: -1px;
 
+  font-family: $font-family-source;
+
   code {
     // Avoid bad formatting in case of <code> elements nested
     // into each other (possible with adoc output)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-open-project
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-31 00:00:00.000000000 Z
+date: 2019-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -165,6 +165,7 @@ files:
 - _includes/featured_posts.html
 - _includes/featured_software.html
 - _includes/featured_specs.html
+- _includes/head.html
 - _includes/home-hero.html
 - _includes/home-hub.html
 - _includes/home-project.html