jekyll-theme-teddy 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66c3a35e32df522b4f0e9c31d3bce1fca9f974cf55863c03fb1ae5c3c207badc
-  data.tar.gz: da1e8c2c5c7ce23eb247013374151e27e0ce9be029f6b1590964d4841a6a90ff
+  metadata.gz: 27ce61bd3617a41831a62371b09cd74b309e1d88f2b0ee1b9bf68e6e6191fc06
+  data.tar.gz: 1566e5f5cf040e220ad1eba77d814ee7bf0e896f1327bf0343e6b5d3c643e200
 SHA512:
-  metadata.gz: 26f295376be936365b6ce469131ff6c08596d1e8aa440027adb957bfea2671f250dd936e44bb35c3ad12e9b97c8505743c09b1f695da032afb8c18f1384c3a0b
-  data.tar.gz: 7e93b16ee528ce75231650470a401c063f5597da922adddcd92328f5d9ae91b9016b3e0821ec1ab303f67cafe7c8a2ae5774eef9057ebfefb07566ededef9d21
+  metadata.gz: b9e8fa51ff66437d1085fd8266c3cc04a8b93f93d4bda0d9f2f33fe48dc1648823d9afc179c8e13e0ccee25181849302890e3b6c9d6a9c37d4c8d879d2a923aa
+  data.tar.gz: c3cf51bd954ae4a0808bb0b9e2c618c1417a38cf652bfc1799f974ec8825efd20f95adc635d3c44654a165e0b7b1f5d8757216b96a31bb259d35a21e6f3df1b5

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2024 Teddy55Codes
-
-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.
+The MIT License (MIT)
+
+Copyright (c) 2024 Teddy55Codes
+
+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

@@ -1,42 +1,84 @@
-# jekyll-theme-teddy
-
-Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
-
-To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your Jekyll site's `Gemfile`:
-
-```ruby
-gem "jekyll-theme-teddy"
-```
-
-And add this line to your Jekyll site's `_config.yml`:
-
-```yaml
-theme: jekyll-theme-teddy
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install jekyll-theme-teddy
-
-## 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-teddy.gemspec` accordingly.
-
-## License
-
-The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# jekyll-theme-teddy
+
+Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
+
+To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your Jekyll site's `Gemfile`:
+
+```ruby
+gem "jekyll-theme-teddy"
+```
+
+And add this line to your Jekyll site's `_config.yml`:
+
+```yaml
+theme: jekyll-theme-teddy
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll-theme-teddy
+
+## Configuration
+There are some variables you can use to customize this theme.
+
+### _config.yml
+* **source_repository_url**\
+  This will be used to link to your repository and individual files in your repository.
+* **source_repository_url_path_prefix**\
+  This is the url part that is between your source_repository_url and the page path.
+  On github this is `blob/main`
+* **last_post**\
+  This is used to add a link to your latest post.
+
+### front matter
+* **title**\
+  Adds a h1 title.
+* **toc**\
+  Auto generate table of contents if set to true.
+* **post (only in home layout)**\
+  This is used to generate the card view on the home page.
+  It accepts a list of objects. 
+  example:
+  ```
+  posts: [
+    {
+      "image": "Resources/img1.png", 
+      "image-alt": "image 1",
+      "link": "Posts/post1", 
+      "title": "Post 1", 
+      "description": "My Post 1", 
+      "footer-text": "January 1970"
+    },
+    {
+      "image": "Resources/img2.png", 
+      "image-alt": "image 2",
+      "link": "Posts/post2", 
+      "title": "Post 2", 
+      "description": "My Post 2", 
+      "footer-text": "January 1970"
+    }
+  }
+  ```
+
+## 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-teddy.gemspec` accordingly.
+
+## License
+
+The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/_layouts/default.html

@@ -1,23 +1,39 @@
-<!DOCTYPE html>
-<html lang="{{ site.lang | default: "en-US" }}">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
-    
-{% seo %}
-    <link rel="stylesheet" href="{{ site.baseurl }}{{ '/assets/css/style.css' }}">
-</head>
-<body>
-
-<main id="content" class="main-content" role="main">
-    {% unless page.url == "/" %}
-    <a href="{{ site.baseurl }}/">Back To Home Page</a>
-    {% endunless %}
-    {{ content }}
-</main>
-<footer class="site-footer">
-    <span class="site-footer-credits">Hosted on <a href="https://pages.github.com">GitHub Pages</a> powered by <a href="https://jekyllrb.com">Jekyll</a>.</span>
-</footer>
-</body>
+---
+css_files:
+- default
+---
+
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
+    
+    {% seo %}
+    {% if layout.css_files %}
+        {% for css_file in layout.css_files %}
+            <link rel="stylesheet" href="{{ site.baseurl }}/assets/css/{{ css_file }}.css">
+        {% endfor %}
+    {% endif %}
+</head>
+<body>
+
+<main id="content" class="main-content" role="main">
+    {{ content }}
+</main>
+<footer>
+    <span>Powered by <a href="https://jekyllrb.com">Jekyll</a> using the <a href="https://github.com/Teddy55Codes/jekyll-theme-teddy">jekyll-theme-teddy</a> theme</span>
+    {% if site.source_repository_url %}
+        <a id="github-icon" href="{{ site.source_repository_url }}">
+            <img alt="github-icon" src="{{ site.baseurl }}/assets/images/github-icon.png">
+        </a>    
+    {% endif %}
+</footer>
+{% if layout.js_files %}
+    {% for js_file in layout.js_files %}
+        <script src="{{ site.baseurl }}/assets/js/{{ js_file }}.js"></script>
+    {% endfor %}
+{% endif %}
+</body>
 </html>

data/_layouts/home.html

@@ -0,0 +1,39 @@
+---
+layout: default
+css_files:
+- default
+- home
+js_files:
+- galaxy-animation
+---
+
+
+<canvas id="canvas"></canvas>
+<div id="home-banner">
+    <h1>{{ page.title }}</h1>
+    <h2>{{ page.subtitle }}</h2>
+    <div class="home-banner-links">
+        {% if site.source_repository_url %}
+        <a href="{{ site.source_repository_url }}">Source Repository</a>
+        {% endif %}
+        {% if site.latest_post %}
+        <a href="{{ site.baseurl }}/{{ site.latest_post }}">Read The Latest Post</a>
+        {% endif %}
+    </div>
+</div>
+
+{{ content }}
+
+<div id="card-container">
+    {% for post in page.posts %}
+    <div class="outer-card">
+        <a class="card" href={{ post.link }}>
+            <img alt={{ post.image-alt }} src={{ post.image }}>
+            <h3>{{ post.title }}</h3>
+            <p>{{ post.description }}</p>
+            <p class="card-date">{{ post.footer-text }}</p>
+        </a>
+    </div>
+    {% endfor %}
+</div>
+

data/_layouts/post.html

@@ -0,0 +1,22 @@
+---
+layout: default
+---
+
+<div id="top-nav">
+    {% unless page.url == "/" %}
+    <a id="home-link" href="{{ site.baseurl }}/"><- Back To Home Page</a>
+    {% endunless %}
+
+    {% if site.source_repository_url and site.source_repository_url_path_prefix %}
+    <a id="source-link" href="{{ site.source_repository_url }}/{{ site.source_repository_url_path_prefix }}/{{ page.path }}">To Source File</a>
+    {% endif %}
+</div>
+
+
+<h1>{{ page.title }}</h1>
+
+{{ content | toc_only }}
+
+<hr>
+
+{{ content | inject_anchors }}

data/_sass/code-highlighting.scss

@@ -1,98 +1,99 @@
-@import "variables";
-
-code {
-  font-family: "JetBrains Mono", Helvetica, Arial, monospace;
-  background: $code-bg-color;
-  border-radius: 5px;
-  padding: 0 3px 0 3px;
-}
-
-pre {
-  background: $code-bg-color;
-  margin: 10px 0 10px 0;
-  padding: 10px;
-  overflow: auto;
-}
-
-.highlight table td { 
-  padding: 5px;
-}
-
-.highlight table pre { 
-  margin: 0; 
-}
-
-.highlight, .highlight .w {
-  color: $code-text-color;
-}
-.highlight .err {
-  color: #151515;
-  background-color: #ac4142;
-}
-.highlight .c, .highlight .cd, .highlight .cm, .highlight .c1, .highlight .cs {
-  color: #888;
-}
-.highlight .cp {
-  color: #f4bf75;
-}
-.highlight .nt {
-  color: #f4bf75;
-}
-.highlight .o, .highlight .ow {
-  color: $code-text-color;
-}
-.highlight .p, .highlight .pi {
-  color: $code-text-color;
-}
-.highlight .gi {
-  color: #90a959;
-}
-.highlight .gd {
-  color: #ac4142;
-}
-.highlight .gh {
-  color: #6a9fb5;
-  font-weight: bold;
-}
-.highlight .k, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kv {
-  color: #aa759f;
-}
-.highlight .kc {
-  color: #d28445;
-}
-.highlight .kt {
-  color: #d28445;
-}
-.highlight .kd {
-  color: #d28445;
-}
-.highlight .s, .highlight .sb, .highlight .sc, .highlight .sd, .highlight .s2, .highlight .sh, .highlight .sx, .highlight .s1 {
-  color: #90a959;
-}
-.highlight .sr {
-  color: #75b5aa;
-}
-.highlight .si {
-  color: #8f5536;
-}
-.highlight .se {
-  color: #8f5536;
-}
-.highlight .nn {
-  color: #f4bf75;
-}
-.highlight .nc {
-  color: #f4bf75;
-}
-.highlight .no {
-  color: #f4bf75;
-}
-.highlight .na {
-  color: #6a9fb5;
-}
-.highlight .m, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mb, .highlight .mx {
-  color: #90a959;
-}
-.highlight .ss {
-  color: #90a959;
+@import "variables";
+
+code {
+  font-family: "JetBrains Mono", Helvetica, Arial, monospace;
+  background: $code-bg-color;
+  border-radius: 5px;
+  padding: 0 3px 0 3px;
+}
+
+pre {
+  background: $code-bg-color;
+  margin: 10px 0 10px 0;
+  padding: 10px;
+  overflow: auto;
+  border-radius: 10px;
+}
+
+.highlight table td { 
+  padding: 5px;
+}
+
+.highlight table pre { 
+  margin: 0; 
+}
+
+.highlight, .highlight .w {
+  color: $code-text-color;
+}
+.highlight .err {
+  color: #151515;
+  background-color: #ac4142;
+}
+.highlight .c, .highlight .cd, .highlight .cm, .highlight .c1, .highlight .cs {
+  color: #888;
+}
+.highlight .cp {
+  color: #f4bf75;
+}
+.highlight .nt {
+  color: #f4bf75;
+}
+.highlight .o, .highlight .ow {
+  color: $code-text-color;
+}
+.highlight .p, .highlight .pi {
+  color: $code-text-color;
+}
+.highlight .gi {
+  color: #90a959;
+}
+.highlight .gd {
+  color: #ac4142;
+}
+.highlight .gh {
+  color: #6a9fb5;
+  font-weight: bold;
+}
+.highlight .k, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kv {
+  color: #aa759f;
+}
+.highlight .kc {
+  color: #d28445;
+}
+.highlight .kt {
+  color: #d28445;
+}
+.highlight .kd {
+  color: #d28445;
+}
+.highlight .s, .highlight .sb, .highlight .sc, .highlight .sd, .highlight .s2, .highlight .sh, .highlight .sx, .highlight .s1 {
+  color: #90a959;
+}
+.highlight .sr {
+  color: #75b5aa;
+}
+.highlight .si {
+  color: #8f5536;
+}
+.highlight .se {
+  color: #8f5536;
+}
+.highlight .nn {
+  color: #f4bf75;
+}
+.highlight .nc {
+  color: #f4bf75;
+}
+.highlight .no {
+  color: #f4bf75;
+}
+.highlight .na {
+  color: #6a9fb5;
+}
+.highlight .m, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mb, .highlight .mx {
+  color: #90a959;
+}
+.highlight .ss {
+  color: #90a959;
 }