jekyll-theme-collider 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e43b46ed2c9fd039a2764d588a90ffb2e35b9240
-  data.tar.gz: c877eb77514601161e9dca36e55fcbf119efbaf4
+SHA256:
+  metadata.gz: 2550936b3fc6679fce2ecc7ad8c4e8087bed07b8d2c1566a4a635010b71348ba
+  data.tar.gz: ad2f77730bcb4bcbc9e8c3d641e53c93563eeba6b100bb266d4bef751da4b8fa
 SHA512:
-  metadata.gz: d4e67c2da8d0b68d28a7dbe9db897cc6ba1ffeeaabbdf0d7f94192feb2709b97e2242e01c0ba7aa444cf461f00514a202cb5c7f775348e979e6cd8308c2f354f
-  data.tar.gz: b15d24054352e11d78e2359d07f9f01516344f1a00a8da68862283dc227767309186b01d569ed4295d6696615ae75edda61a149aa92c13e9b3a8ae79f83a55ec
+  metadata.gz: c18e523a9b7cdcfd120ca308ae528d2996ac3118fedf8173d5443c4ddaa25f7ec810c7cc0018f8893cbe16aa345858ae0a298317ef73ebb9c02188a3b753b8d0
+  data.tar.gz: 4fc724699298e500dcf63fd1d5d13b92d635e8acba35ab15b815b52863cb1723a4fa1d72fa8123de14d130875479ca73becd800fb9b68c7a24eebbaf7fbcd752

data/README.md

@@ -1,5 +1,21 @@
 # jekyll-theme-collider
 
+- [About](#about)  
+- [Installation](#installation)  
+  - [Jekyll requirements](#jekyll-requirements)
+  - [Create a local copy of the site](#create-a-local-copy-of-the-site)
+  - [Install theme using gem](#install-theme-using-gem)
+  - [Troubleshooting](#troubleshooting)
+- [Tags](#tags)  
+- [Colors](#colors)  
+  - [Page header colors](#page-header-colors)
+  - [Homepage background color](#homepage-background-color)
+- [About page customization](#about-page-customization)
+- [Customizing particles js](#customizing-particles-js)  
+- [Future projects](#future-projects)  
+- [Contributing](#contributing)  
+- [License](#license)  
+
 ## About
 This theme has two main nifty features, the use of [particles.js](https://vincentgarreau.com/particles.js/) and the [jekyll-paginate-v2 plugin](https://github.com/sverrirs/jekyll-paginate-v2/tree/master/examples). For those who don't know, the jekyll-paginate-v2 plugin allows you to do cool things like paginate within a given collection, which the current jekyll-paginate gem does not allow.
 
@@ -7,16 +23,14 @@ I'm also using the powers of [ITCSS](https://github.com/ahmadajmi/awesome-itcss)
 
 The font I'm using is a favorite of mine, [Operator Mono SSm](https://www.typography.com/fonts/operator/styles/operatormonoscreensmart). Also notice the fun use of colors on tags and each page, these are easily customizable by design and is detailed below.
 
-Please [contact me](https://www.ryandevelops.com/contact) if you are interested in contributing to this theme or have any ideas for improvement!
-
 ## Installation
-**Jekyll requirements**
+#### Jekyll requirements
 * You must have Ruby installed:
     * https://www.ruby-lang.org/en/downloads/
 * Install Jekyll and Bundler:
     * `gem install jekyll bundler`
 
-**Create a local copy of the site**
+#### Create a local copy of the site
 * Download this site:
     * `git clone https://github.com/ryancolorcafe/jekyll-theme-collider.git`
 * Move into directory:
@@ -27,7 +41,7 @@ Please [contact me](https://www.ryandevelops.com/contact) if you are interested
     * `bundle exec jekyll serve`
     * Browse to http://localhost:4000
 
-**Install theme using gem**
+#### Install theme using gem
 * Add this line to your Gemfile:
     * `gem "jekyll-theme-collider"`
 * Install running this command in your terminal:
@@ -54,6 +68,19 @@ Please [contact me](https://www.ryandevelops.com/contact) if you are interested
 * Finally, add the following to config.yml:
 
 ```
+title: [Your site title here]
+email: [Your email]
+description: >
+  [Your site description]
+baseurl: "" # the subpath of your site, e.g. /blog
+url: "https://jekyll-theme-collider.netlify.com"  # the base hostname & protocol for your site, e.g. http://example.com
+github_username: [Your GitHub user name]
+linked_in_profile: [LinkedIn profile url]
+full_name: [Your username]
+user_description: [Your description]
+disqus:
+  shortname: [Your Disqus shortname] # https://disqus.com
+
 theme: jekyll-theme-collider
 
 plugins:
@@ -82,17 +109,11 @@ pagination:
 * Run your server and you should be good to go!  
   * `bundle exec jekyll serve`
 
-**Troubleshooting:**
+#### Troubleshooting:
 * The `curl -L -O` commands may not have fully downloaded each file. Even if it seems the file was fully downloaded, open each one to make sure that it doesn't just contain a 503 error inside. Delete the files with errors and retry the curl commands.  
 * You may need to restart your server in order for your changes to take effect.
 
-## Site configuration
-
-**Config file:**
-
-Be sure to add your own site title, email, github username, etc. in config.yml.
-
-**Tags:**
+## Tags
 
 To create a new tag, make a new file in the `tags` directory with the name of the tag you'd like to use. The structure of each is the following:
 
@@ -110,7 +131,7 @@ pagination:
 
 All posts tagged with _Jekyll_
 ```
-If you're familiar with Jekyll, most of this will look familiar. The parts unique to this theme are the color and the pagination configurations. The color configured here will determine the color of the tag page header and is based on SCSS color settings, meaning it's not just the default CSS purple color being used here. More on that in another section.
+If you're familiar with Jekyll [front matter](https://jekyllrb.com/docs/front-matter/), this configuration will be intuitive. The parts unique to this theme are the color and the pagination configurations. The color configured here will determine the color of the tag page header and is based on SCSS color settings, meaning it's not just the default CSS purple color being used here. More on that in the colors section below.
 
 The pagination settings are necessary to set for the jekyll-pagination-v2 plugin. The only one you'll likely want to ever modify here is the `tag:` setting, where you simply put the tag name you'd like to use in lowercase.
 
@@ -120,11 +141,14 @@ You'll also want to create a new file in the `_blog_tags` directory that is also
 color: purple
 ---
 ```
+In order to configure the colors as above, and make your own custom colors, see the section on colors below.
 
-**Colors**
+## Colors
 
 If using this theme as a gem, see [overriding theme defaults](https://jekyllrb.com/docs/themes/#overriding-theme-defaults) in the Jekyll docs as you will need to make a copy of the following files.
 
+#### Page header colors
+
 To set up a new color variable in the SCSS, you may do so in `settings/_color.scss`. To create a new reusable color class that can be used for tag pages and the tags themselves, go to `elements/_colors.scss`. The structure a new color classes should look like the following:
 
 ```
@@ -147,9 +171,39 @@ a.bg--orange:hover {
 
 This is what would allow you to simply configure `color: orange` in your `tags` and `_blog_tags` directory files. For an example of what is happening under the hood, you can take a look at the `_includes/header.html` file, lines 1-15.
 
+#### Homepage background color
+
+To change the background color of the particles.js canvas on the homepage, go to `components/_particles.scss` and change the background color here:
+```
+#particles-js {
+  background: $dark-sea-green;
+}
+```
+
+## About page customization
+
+If creating a local copy of the site, simple modify the HTML and text in `_layouts/about.html`. When using the gem theme, create a new `_layouts` directory with an `about.html` file inside that use the following front matter:
+```
+---
+layout: default
+---
+```
+You may put whatever HTML and text you'd like below.
+
+## Customizing particles js
+
+To customize particles.js, such as the shape and size of the particles, you'll need to edit `assets/js/app.js`. If using the theme gem, you'll need to create this file and override with your own settings. Since this customization is outside the scope of this readme, I recommend learning more on the particles.js [GitHub page](https://github.com/VincentGarreau/particles.js/).
+
 ## Future projects
 
-* Add comments to posts using Disqus  
 * A portfolio/work page using CSS Grid  
 * Search bar for articles in blog  
 * Modular scale typography  
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ryancolorcafe/jekyll-theme-collider. 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.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_includes/disqus_comments.html

@@ -0,0 +1,16 @@
+{% if page.comments != false %}
+  <div id="disqus_thread"></div>
+  <script>
+    var disqus_config = function () {
+    this.page.url = '{{ page.url | absolute_url }}';  // Replace PAGE_URL with your page's canonical URL variable
+    this.page.identifier = '{{ page.url | absolute_url }}'; // 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.disqus.shortname}}.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>
+{% endif %}

data/_layouts/default.html

@@ -5,8 +5,8 @@
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta property="og:image" content="{{ "/assets/images/theme-image.png" | prepend: site.baseurl }}">
     <meta property="og:description" content="The Collider Jekyll Theme is a gem-based theme that helps makes use of the jekyll-paginate-v2 plugin and particles.js.">
-    <meta property="og:title" content="Collider Jekyll Theme">
-    <meta property="og:url" content="//{{site.hosted_url}}">
+    <meta property="og:title" content="{{site.meta_title}}">
+    <meta property="og:url" content="//{{site.url}}">
     <link rel="stylesheet" href="{{ "/assets/css/main.css" | prepend: site.baseurl }}">
     <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous">
   </head>

data/_layouts/home.html

@@ -6,11 +6,11 @@ layout: default
   {% include header.html %}
   <div class="site-title__wrapper">
     <h1>
-      <span class="site-title__text">{{site.username}}</span>
-      <span class="site-title__text--sub">{{site.user_title}}</span>
+      <span class="site-title__text">{{site.full_name}}</span>
+      <span class="site-title__text--sub">{{site.user_description}}</span>
     </h1>
     <a href="https://github.com/{{site.github_username}}" target="_blank"><i class="fab fa-github fa-3x"></i></a>
-    <a href="https://www.linkedin.com/in/{{site.linked_in_profile_name}}/" target="_blank"><i class="fab fa-linkedin-in fa-3x"></i></a>
+    <a href="{{site.linked_in_profile}}" target="_blank"><i class="fab fa-linkedin-in fa-3x"></i></a>
   </div>
 </div>
 

data/_sass/jekyll-theme-collider/generic/_normalize.scss

@@ -21,3 +21,7 @@ body {
   background-color: #000;
   color: $white;
 }
+
+img {
+  width: 100%;
+}

data/_sass/jekyll-theme-collider/helpers/_syntax-highlighting.scss

@@ -0,0 +1,81 @@
+/**
+ * Syntax highlighting styles
+ */
+
+pre {
+ white-space: pre-wrap;
+}
+
+.highlight {
+  background: whitesmoke;
+  padding: 8px 12px;
+  margin: 20px 0 0 0;
+
+  .highlighter-rouge & {
+    background: #eef;
+  }
+
+  .c     { color: #998; font-style: italic } // Comment
+  .err   { color: #a61717; background-color: #e3d2d2 } // Error
+  .k     { font-weight: bold } // Keyword
+  .o     { font-weight: bold } // Operator
+  .cm    { color: #998; font-style: italic } // Comment.Multiline
+  .cp    { color: #999; font-weight: bold } // Comment.Preproc
+  .c1    { color: #998; font-style: italic } // Comment.Single
+  .cs    { color: #999; font-weight: bold; font-style: italic } // Comment.Special
+  .gd    { color: #000; background-color: #fdd } // Generic.Deleted
+  .gd .x { color: #000; background-color: #faa } // Generic.Deleted.Specific
+  .ge    { font-style: italic } // Generic.Emph
+  .gr    { color: #a00 } // Generic.Error
+  .gh    { color: #999 } // Generic.Heading
+  .gi    { color: #000; background-color: #dfd } // Generic.Inserted
+  .gi .x { color: #000; background-color: #afa } // Generic.Inserted.Specific
+  .go    { color: #888 } // Generic.Output
+  .gp    { color: #555 } // Generic.Prompt
+  .gs    { font-weight: bold } // Generic.Strong
+  .gu    { color: #aaa } // Generic.Subheading
+  .gt    { color: #a00 } // Generic.Traceback
+  .kc    { font-weight: bold } // Keyword.Constant
+  .kd    { font-weight: bold } // Keyword.Declaration
+  .kp    { font-weight: bold } // Keyword.Pseudo
+  .kr    { font-weight: bold } // Keyword.Reserved
+  .kt    { color: #458; font-weight: bold } // Keyword.Type
+  .m     { color: #099 } // Literal.Number
+  .s     { color: #d14 } // Literal.String
+  .na    { color: #008080 } // Name.Attribute
+  .nb    { color: #0086B3 } // Name.Builtin
+  .nc    { color: #458; font-weight: bold } // Name.Class
+  .no    { color: #008080 } // Name.Constant
+  .ni    { color: #800080 } // Name.Entity
+  .ne    { color: #900; font-weight: bold } // Name.Exception
+  .nf    { color: #900; font-weight: bold } // Name.Function
+  .nn    { color: #555 } // Name.Namespace
+  .nt    { color: #000080 } // Name.Tag
+  .nv    { color: #008080 } // Name.Variable
+  .ow    { font-weight: bold } // Operator.Word
+  .w     { color: #bbb } // Text.Whitespace
+  .mf    { color: #099 } // Literal.Number.Float
+  .mh    { color: #099 } // Literal.Number.Hex
+  .mi    { color: #099 } // Literal.Number.Integer
+  .mo    { color: #099 } // Literal.Number.Oct
+  .sb    { color: #d14 } // Literal.String.Backtick
+  .sc    { color: #d14 } // Literal.String.Char
+  .sd    { color: #d14 } // Literal.String.Doc
+  .s2    { color: #d14 } // Literal.String.Double
+  .se    { color: #d14 } // Literal.String.Escape
+  .sh    { color: #d14 } // Literal.String.Heredoc
+  .si    { color: #d14 } // Literal.String.Interpol
+  .sx    { color: #d14 } // Literal.String.Other
+  .sr    { color: #009926 } // Literal.String.Regex
+  .s1    { color: #d14 } // Literal.String.Single
+  .ss    { color: #990073 } // Literal.String.Symbol
+  .bp    { color: #999 } // Name.Builtin.Pseudo
+  .vc    { color: #008080 } // Name.Variable.Class
+  .vg    { color: #008080 } // Name.Variable.Global
+  .vi    { color: #008080 } // Name.Variable.Instance
+  .il    { color: #099 } // Literal.Number.Integer.Long
+}
+
+.highlighter-rouge {
+   background-color: whitesmoke;
+ }

data/_sass/jekyll-theme-collider/jekyll-theme-collider.scss

@@ -23,3 +23,4 @@
 
 // Helpers
 @import "helpers/helpers";
+@import "helpers/syntax-highlighting";

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-collider
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Ryan Brown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-25 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 3.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 3.9.1
 - !ruby/object:Gem::Dependency
   name: jekyll-paginate-v2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.9.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: 1.9.4
 - !ruby/object:Gem::Dependency
   name: jekyll-feed
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown-parser-gfm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +103,7 @@ extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- _includes/disqus_comments.html
 - _includes/header.html
 - _includes/pagination.html
 - _layouts/about.html
@@ -110,6 +125,7 @@ files:
 - _sass/jekyll-theme-collider/generic/_font.scss
 - _sass/jekyll-theme-collider/generic/_normalize.scss
 - _sass/jekyll-theme-collider/helpers/_helpers.scss
+- _sass/jekyll-theme-collider/helpers/_syntax-highlighting.scss
 - _sass/jekyll-theme-collider/jekyll-theme-collider.scss
 - _sass/jekyll-theme-collider/settings/_colors.scss
 - assets/css/main.scss
@@ -143,8 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A simple blog using jekyll-paginate-v2 and particles.js