simport 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1078fad9bbbedf185760ad009271bee2a9d95b1d
-  data.tar.gz: 1effaac10b827b664af654104243c88298177406
+  metadata.gz: b2ba933edadec7d2c0e1474b61b88e1741bda528
+  data.tar.gz: 43ea695c900a3971c91a0ea18317c44654039393
 SHA512:
-  metadata.gz: bf90af568889ac8cb3106e975b41134ded2b7c5da2495cd7b6557d5b877c897b13be93ddcc61a22708fa5644356cda6948134789593279ac5f45c5ce208605e5
-  data.tar.gz: 297be3d4a3b8f2eba38c4067b080729c793f5c2b91457e865f61b19fcaa06f91782778ce7da4670dd9c80b6f5e50023ae9a6e95d43e1b548762f1e85d08d5ae1
+  metadata.gz: 8cc5bef49aa2038ee3e862553af731383e0e8dc2590c3fe67950f84dd624d7fb168940a77d3e82ee44d1afbc785e253a2c434c90f5b453cc25d2f009e04cac32
+  data.tar.gz: e71cbe4b5c77bb5c94fe8c12e0a67b516da16dea35c62b8a2e3e4ae05a15edce52233c8f407ce3535583006f101ebdfe16382b153f3a4d9607636495c4c0b8db

data/README.md

@@ -2,37 +2,53 @@
 
 A **sim**ple **por**tfolio and blog theme for jekyll.
 
-## Installation
+## Getting Started
 
-Add this line to your Jekyll site's `Gemfile`:
+Create a new directory and run the `jekyll new {site name}` command. 
+
+Add the following to your Jekyll site's `Gemfile` (see below for explanation on the plugins):
 
 ```ruby
 gem "simport"
+
+group :jekyll_plugins do
+  gem 'jekyll-sitemap'
+  gem 'jekyll-feed'
+  gem 'jekyll-seo-tag'
+end
 ```
 
-And add this line to your Jekyll site's `_config.yml`:
+Then add this line to your Jekyll site's `_config.yml`:
 
 ```yaml
 theme: simport
+plugins:
+  - jekyll-feed
+  - jekyll-sitemap
+  - jekyll-seo-tag
+```
+
+Finally add an `index.md` with the following:
+```
+---
+layout: home
+---
 ```
 
 And then execute:
 
     $ bundle
-
-Or install it yourself as:
-
-    $ gem install simport
+    $ bundle exec jekyll serve
 
 ## Usage
 
-### Adding a homepage
+### Homepage
 
-To get started you must have a homepage. This is done with by adding either an `index.md` or `index.html` file in the root directory. There is a home layout below that was designed for this page.
+To get started you must have a homepage. This is done with by adding either an `index.md` or `index.html` file in the root directory. There is a home layout below that was designed for this page. 
 
 ### Adding a logo
 
-There is a default logo in the navbar at the top left of the page. This can be overridden by createing an `_includes/logo.html` file.
+There is a default logo in the navbar at the top left of the page. This can be overridden by creating an `_includes/logo.html` file.
 
 ### Adding a top level page
 
@@ -80,6 +96,14 @@ excerpt: An intro to bananas
 
 This is the layout that includes the navbar. This has no styling and can be used for any cusom pages.
 
+## Plugins
+
+These three official plugins are useful Jekyll sites and are required to get started:
+
+[jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap) - Creates a sitemap file to help search engines index content
+[jekyll-feed](https://github.com/jekyll/jekyll-feed) - Creates an RSS feed for your posts
+[jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag) - Adds meta tags to help with SEO
+
 ## 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.

data/_includes/navigation.html

@@ -1,7 +1,7 @@
 <nav>
     <nav>
         <div id="logo" class="left">
-            <a href="/">
+            <a href="{{ '/' | relative_url }}">
                 <button class="nav-button left" type="button">
                     {% include logo.html %}
                 </button>
@@ -10,7 +10,7 @@
         <div id="navbar-navigation" class="right">
             {% assign sorted = site.data.navigation | reverse %}
             {% for item in sorted %}
-            <a href='{{item.link}}'>
+            <a href="{{ item.link | relative_url }}">
                 <button class="nav-button right" type="button">
                     <span>{{item.name}}</span>
                 </button>

data/_layouts/blog.html

@@ -3,7 +3,7 @@ layout: default
 ---
 <div id="blog">
     {% for post in site.posts %}
-    <a href="{{ post.url }}">
+    <a href="'{{ post.url | relative_url }}'">
         <div class="blog-post">
             <h6 class="blog-date">{{ post.date | date_to_string }}</h6>
             <h2 class="blog-title">{{ post.title }}</h2>

data/_layouts/default.html

@@ -13,6 +13,6 @@
             {{ content }}
         </main>
     </body>
-    <script src="/assets/js/highlight.pack.min.js"></script>
+    <script src="{{ '/assets/js/highlight.pack.min.js' | relative_url }}"></script>
     <script>hljs.initHighlightingOnLoad();</script>
 </html>

data/_layouts/tils.html

@@ -3,7 +3,7 @@ layout: default
 ---
 <div id="blog">
     {% for til in site.tils %}
-    <a href="{{ til.url }}">
+    <a href="{{ til.url | relative_url }}">
         <div class="blog-post">
             <h6 class="blog-date">{{ til.date | date_to_string }}</h6>
             <h2 class="blog-title">{{ til.title }}</h2>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simport
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Redhwan Nacef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-01 00:00:00.000000000 Z
+date: 2019-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll