askclass-news-theme 0.2.6 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f18ce893aef7881601b3bdc4e354de93727d83c2a8eed7bf6834a47a2029d02
-  data.tar.gz: '0580cfdab10fe469e8158140e7cb2f5da0941f8ac4972d8f641dee024dcefbce'
+  metadata.gz: fa810195c6d88cabcdab1f762396eea0c2a8620d39d8bae626168c3f6056b534
+  data.tar.gz: 4f98f4a2b5b51d58d88193a4a8b8a520dbb05173f0422be882c1717f5c7f7d7e
 SHA512:
-  metadata.gz: 5234c3c583648f1269d9fb3ca7fdfbaf2ff378fe9b952769f7888f81b40708ee58b09e616f22a0acd9bb01736026eeb8950511f58ef0c897ca8402d1627c8e89
-  data.tar.gz: 872f634cc6f601882b58a64d5c7bf97366ff4bd43f976fba9f4bf4ef88dac63dca1416b1f01d9c636b13942cf0b0157ec491ca9f1d9f39a512702d6ac8f896b8
+  metadata.gz: a1deabe9f8058a0621db3e0b1b50a88b8e637e12f62d66d25c710ad6ca65dd42b1b469db02e8d788a05984b0d33ac0179330fe30d16374ef412d64ad342e31ec
+  data.tar.gz: 23550cb56c4ad467199eb3341ed85954e05f5fd2519a997c022f60aa2791cbb9e7aaae0b58115d9f0e75e0fda539e0e45cebe1c47531fe54af98065066da27e7

data/README.md

@@ -4,40 +4,68 @@ Simple responsive Jekyll theme featuring posts and authors.
 
 ## Installation
 
-Add this line to your Jekyll site's `Gemfile`:
+```sh
+# If starting fresh add this
+$ echo 'source "https://rubygems.org"' > Gemfile
 
-```ruby
-gem "askclass-news-theme"
+$ echo 'gem "askclass-news-theme"' >> Gemfile
+$ sed -i '1 s/^/theme: askclass-news-theme\n/' _config.yml
+$ bundle
 ```
 
-And add this line to your Jekyll site's `_config.yml`:
-
-```yaml
-theme: askclass-news-theme
+## Configuration
+
+Copy these files:
+- `index.html`
+- `config.yml` (edit this to fit your need)
+- `content/` (whole folder as an example)
+- `pwabuilder-sw.js` (PWA)
+
+## Post File Format
+
+```md
+---
+# Don't change this
+layout: post
+# Well, what else could this be?
+title: The Hobbit
+# This is your author's name
+category: J.R.R._Tolkien
+# Alternatively
+writer: J.R.R Tolkien
+# Values: c1 .. c10
+color: c1
+# Tags separated by spaces
+tags: fiction fantasy
+# Optional title image (shows up on index)
+image: https://article.images/iamge.jpg
+# Optional source info
+source: The Tolkien Society
+source_url: https://www.tolkiensociety.org/
+---
+
+Whatever is here goes gets on index.
+<!--more-->
+The rest of the article.
 ```
 
-And then execute:
-
-```sh
-$ bundle
+## Writer File Format
+
+```md
+---
+# Don't change this
+layout: writer
+# Optional size of image
+size: 100
+# Optional position of the profile image either center or left
+style: center
+# Optional image
+image: https://author.images/tolkien.jpg
+---
+
+Biography.
 ```
 
-## Usage
-
-Customizable fields in the `_config.yaml`:
-
-Field | Description
-:--- | :---
-`title` | Name of the site
-`description` | Describe the site
-`site_url` | For meta field
-`site_cat` | [Manifest Categories] used in `manifest.json`
-`twitter` | Optional Twitter handle for meta field
-`logo` | Logo images and sizes for header of the page
-`color` | For dressing the splash screen and chrome
-`footer` | Bottom of the page info
-`font_families` | Which [Google Fonts] to load (edit `_sass/_default.scss` correspondingly)
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/beAuthentic/askclass-news-theme.

data/_config.yml

@@ -29,6 +29,18 @@ acn:
       favicon: "favicon.ico"
       type: "image/png"
       image: "logo-96.png"
+    keywords: >
+      edtech,
+      education,
+      technology,
+      learning,
+      teaching,
+      student,
+      educator,
+      university,
+      icebreaker,
+      student engagement,
+      participation
   footer:
     - icon: "copyright"
       href: "https://askclass.com"
@@ -36,6 +48,7 @@ acn:
     - icon: "toys"
       href: "https://app.askclass.com"
       text: "Icebreakers"
+  # Donot change the below (will figure something out later)
   font_families:
     - Teko
     - Open+Sans

data/_includes/head/common.html

@@ -15,6 +15,7 @@
   <meta name="theme-color" content="{{ acn.color.theme }}" />
   <meta name="apple-mobile-web-app-status-bar-style" content="{{ acn.color.theme }}" />
   <meta name="description" content="{{ desc }}" />
+  <meta name="keywords" content="{{ acn.meta.keywords | strip_newlines }}" />
 
   <meta property="og:site_name" content="{{ site.title }}" />
   <meta property="og:description" content="{{ desc }}" />

data/_includes/head/meta.html

@@ -11,3 +11,4 @@
 {% endif %}
   <title>{{ title | default: site.title }}</title>
   <meta property="og:title" content="{{ title | default: site.title }}" />
+  <meta name="author" content="{{ writer | default: site.title }}" />

data/_sass/_bullets.scss

@@ -4,14 +4,6 @@ ol > li > ul > li {
 ol > li > ol > li {
   list-style: lower-alpha;
 }
-ul > li > ul {
-  list-style: none;
-  li::before {
-    content: "\2022";
-    color: var(--secondaryColor);
-    font-weight: bold;
-    margin-left: -1em;
-    width: 1em;
-    display: inline-block;
-  }
+ul > li > ul > li {
+  list-style-type: square;
 }

data/_sass/_default.scss

@@ -1,8 +1,7 @@
-$specialFont: 'Josefin Sans', sans-serif;
 $mainFont: 'Open Sans', sans-serif;
 $secondaryFont: 'Teko', sans-serif;
+$specialFont: 'Josefin Sans', sans-serif;
 $monoFont: 'Share Tech Mono', monospace;
-$textFont: 'Lexend', sans-serif;
 $primaryColor: aliceblue;
 $secondaryColor: skyblue;
 $linkColor: deeppink;
@@ -18,7 +17,6 @@ html {
   --mainFont: #{$mainFont};
   --secondaryFont: #{$secondaryFont};
   --monoFont: #{$monoFont};
-  --textFont: #{$textFont};
   --primaryColor: #{$primaryColor};
   --secondaryColor: #{$secondaryColor};
   --linkColor: #{$linkColor};
@@ -161,6 +159,7 @@ footer {
   color: $darkColor;
   font-size: 14px;
   ul {
+    padding: 0;
     display: flex;
     li {
       @include align-middle();

data/_sass/_table.scss

@@ -2,16 +2,17 @@ $odd: #3f3f3f;
 $header: #2f2f2f;
 $border: #333;
 
-table, th, td {
+table {
   border-bottom: 1px solid $border;
   border-collapse: collapse;
-  padding: 5px;
-}
-
-th {
-  background-color: $header;
-}
-
-tr:nth-child(odd) {
-  background-color: $odd;
+  th {
+    background-color: $header;
+  }
+  tr:nth-child(even) {
+    background-color: $odd;
+  }
+  td, th {
+    vertical-align: top;
+    padding: 5px;
+  }
 }

data/assets/css/md.scss

@@ -4,4 +4,5 @@
 @import "post";
 @import "paginator";
 @import "bullets";
+@import "table";
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: askclass-news-theme
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.9
 platform: ruby
 authors:
 - AskClass
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-17 00:00:00.000000000 Z
+date: 2022-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll