simple-gh-pages-theme 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b807d8c650f10418abcc0c706ffd1c650507409b2ef50a4a6f278333a22622
-  data.tar.gz: 973d492bd1fa490a39071abfbc1bcbd1454caa6064be5f62194c99d3e8b84d9d
+  metadata.gz: 76f74777454e6c817541ffd856c597ceb29108fcfc2ca2e1ff8710929e5b12a8
+  data.tar.gz: f4bef2936b68df0052a2622e161eacfb0ae5e510eb2c37d1054bd9c4d097ec00
 SHA512:
-  metadata.gz: 47549fede30cf7138a9393174e48757585a4d96d1fa79eee44ef12dfa30945cd028b1f95388e42861106d42238a6fe09c41ef25fcae0040af9deb9928c7f893d
-  data.tar.gz: ce01829d02aa82aa0abc54af35291121ac55c47239824ade736ce189a75a480b5dc3a352a514ce98286f8895c7e72f3d5dbf9743f3fd5beee058439fbcc2eed8
+  metadata.gz: cf6ba10ddddb570f4422e031bc33b48ce886e053c059d7375042a9c5c97a557ed32b6f81205b57cb015208b309c9ca2d0c7b07873479f357d0ca868bc0a9cc43
+  data.tar.gz: f3d8f92f9537a48deaff67323120ef1975e07b3c14bba368fd277d9f1142194f1da9767add52ba3ac1d812314818d22aeff59f0b3d3794c3b6fc37d774e398a6

data/README.md

@@ -11,57 +11,41 @@
 simple-gh-pages-theme, after install and first post setup                            
 </td>
 <td>
-in-use
+in-use: https://jordiwippert.nl
 </td>
 </tr>
 </table>
 
-## Installation
+## Quick installation
+
+1. Add this line to your Jekyll site's `Gemfile`:
 
-Add this line to your Jekyll site's `Gemfile`:
 ```ruby
 gem "simple-gh-pages-theme"
 ```
 
-And add this line to your Jekyll site's `_config.yml`. Remove/disable possibly already enabled themes:
+2. Add this line to your Jekyll site's `_config.yml`. Remove/disable possibly already enabled themes:
+
 ```yaml
 theme: simple-gh-pages-theme
 ```
 
-And then execute:
+3. And then execute:
+
 ```shell
 bundle
-OR
-gem install simple-gh-pages-theme
 ```
-### !!! Important. To make the layouts work properly.
 
-If you created a new website (`jekyll new sitename`), you can make your pages use the layout by changing:
+4. Run install script to create 'posts.md'
 
-- **index.markdown**: 
-```
----
-layout: index
----
-```
-- **about.markdown**:
-```
----
-layout: post
-permalink: /about.html 
----
-```
-- **posts.markdown**: (file might not exist yet)
-```
----
-layout: posts
----
-```
-- **404.markdown**: (file might not exist yet)
+```shell
+bundle exec install-theme
 ```
----
-layout: 404
----
+
+5. When you now run your website locally on `http://localhost:4000`, it should show the theme:
+
+```shell
+bundle exec jekyll serve
 ```
 
 ## Configuration:
@@ -69,6 +53,7 @@ layout: 404
 See/use example config [here](https://github.com/LiveNL/simple-gh-pages-theme/blob/main/example-config.yml). Copy to `_config.yml`
 
 ## Usage
+
 ### Posts
 
 Create your posts like:
@@ -87,20 +72,10 @@ categories: [category]
 tags:       [tag]
 highlight:  false (if true: it will be used on about page, more here)
 short:      false (if true: it shown in 'short' list on home page)
-list_post:  false (if true: it shown in list on home/posts page)
 ```
 
-## Development
-
-To set up your environment to develop this theme, run `bundle install`.
-
-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.
-
 ## Contributing
+
 Bug reports and pull requests are welcome on GitHub at https://github.com/lvenl/simple-gh-pages-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
 
 ## License

data/_config.yml

@@ -0,0 +1,57 @@
+theme: simple-gh-pages-theme
+title: "My website"
+description: "The website description"
+domain: "username.github.io"
+baseurl: ""
+url: ""
+gtag: "G-XXXXXXXXX" # (your google tag)
+
+about:
+  name: Firstname Lastname
+  site: "https://example.com"
+  avatar: assets/images/image.png
+  email: example@example.com
+  socials:
+    twitter: https://twitter.com/example
+    linkedin: https://www.linkedin.com/in/example/
+    github: https://github.com/example
+    keybase: https://keybase.io/example
+    medium: https://medium.com/@example
+    stack-overflow: https://stackoverflow.com/users/xxxxxx/example
+
+plugins:
+  - jekyll-archives
+  - jekyll-redirect-from
+  - jekyll-sitemap
+
+jekyll-archives:
+  enabled:
+    - tags
+    - categories
+  layout: category-posts
+  permalinks:
+    year: "/:year/"
+    month: "/:year/:month/"
+    day: "/:year/:month/:day/"
+    tag: "/tag/:name/"
+    category: "/category/:name/"
+
+defaults:
+  - scope:
+      path: "assets/**"
+    values:
+      sitemap: false
+
+# Excluded items can be processed by explicitly listing the directories or
+# their entries' file path in the `include:` list.
+exclude:
+  - .sass-cache/
+  - .jekyll-cache/
+  - gemfiles/
+  - Gemfile
+  - Gemfile.lock
+  - node_modules/
+  - vendor/bundle/
+  - vendor/cache/
+  - vendor/gems/
+  - vendor/ruby/

data/_data/navigation.yml

@@ -1,6 +1,6 @@
 - name: Home
   link: /
 - name: Posts
-  link: /posts.html
+  link: /posts/
 - name: About
-  link: /about.html
+  link: /about/

data/_includes/highlights.html

@@ -1,12 +1,13 @@
 <table>
-  {% assign selection = site.posts | where_exp:"post", "post.highlight == true"
-  %} {% for post in selection %}
+  <!-- prettier-ignore -->
+  {% assign selection = site.posts | where_exp:"post", "post.highlight == true" %}
+  {% for post in selection %}
   <tr>
     <td>
       <h4><span class="date">{{ post.date | date: "%b '%y"}}</span></h4>
     </td>
     <td>
-      {% if post.list_post == true %}
+      {% if post.layout == 'post' and post.content.size > 1 %}
       <a href="{{ post.url }}" style="text-decoration: none !important">
         <h4>&nbsp;{{ post.title }}</h4>
       </a>

data/_includes/sidebar-categories.html

@@ -6,7 +6,8 @@
     {% assign nr_of_posts = 0 %}
     {% assign cat = category | first %}
     {% assign posts = site.categories[cat] %}
-    {% assign selection = posts | where_exp:"post", "post.list_post == true" %}
+    {% assign selection = posts | where_exp:"post", "post.layout == 'post'" %}
+    {% assign selection = selection | where_exp:"post", "post.content.size > 1" %}
     {% for post in selection %}
       {% assign nr_of_posts = nr_of_posts | plus:1 %}
     {% endfor %}
@@ -30,7 +31,8 @@
     {% assign nr_of_posts = 0 %}
     {% assign tag = tag_post | first %}
     {% assign tag_posts = site.tags[tag] %}
-    {% assign tag_posts_selection = tag_posts | where_exp:"post", "post.list_post == true" %}
+    {% assign tag_posts_selection = tag_posts | where_exp:"post", "post.layout == 'post'" %}
+    {% assign tag_posts_selection = tag_posts_selection | where_exp:"post", "post.content.size > 1" %}
     {% for post in tag_posts_selection  %}
       {% assign nr_of_posts = nr_of_posts | plus:1 %}
     {% endfor %}

data/_layouts/category-posts.html

@@ -6,11 +6,12 @@ title: categories
 <div class="content">
   <div class="posts-all">
     <!-- prettier-ignore -->
-    {% assign selection = page.posts | where_exp:"post", "post.list_post == true" %}
-  {% for post in selection %}
-    {% include post-list-item.html %}
-    {% assign nr_of_posts = nr_of_posts | plus:1 %}
-  {% endfor %}
+    {% assign selection = page.posts | where_exp:"post", "post.layout == 'post'" %}
+    {% assign selection = selection | where_exp:"post", "post.content.size > 1" %}
+    {% for post in selection %}
+      {% include post-list-item.html %}
+      {% assign nr_of_posts = nr_of_posts | plus:1 %}
+    {% endfor %}
   </div>
 
   <div class="sidebar-short">

data/_layouts/home.html

@@ -0,0 +1,4 @@
+---
+layout: index
+title: home
+---

data/_layouts/index.html

@@ -6,13 +6,12 @@ title: home
 <div class="content">
   <div class="posts-top">
     <!-- prettier-ignore -->
-    {% assign selection = site.posts | where_exp:"post", "post.list_post == true" %}
     {% assign selection = site.posts | where_exp:"post", "post.short != true" %}
     {% for post in selection limit: 5 %}
       {% include post-list-item.html %}
     {% endfor %}
     <h2 style="font-family: 'Arvo'">
-      <a href="{{site.baseurl}}/posts.html">&#10095;&nbsp; All posts </a>
+      <a href="{{site.baseurl}}/posts/">&#10095;&nbsp; All posts </a>
     </h2>
   </div>
 

data/_layouts/page.html

@@ -0,0 +1,12 @@
+---
+layout: default
+title: page
+---
+
+<div class="post-content" style="width: 100%">
+  <div class="div-post-title title">
+    {{ page.title }}
+    <div class="line"></div>
+  </div>
+  {{ content }}
+</div>

data/_layouts/posts.html

@@ -1,13 +1,14 @@
 ---
-permalink: /posts.html
 layout: default
+permalink: /posts/
 ---
 
 <div class="content">
   <div class="posts-all">
     <!-- prettier-ignore -->
-    {% assign selection = site.posts | where_exp:"post", "post.list_post == true" %}
-    {% for post in selection  %}
+    {% assign selection = site.posts | where_exp:"post", "post.layout == 'post'" %}
+    {% assign selection = selection | where_exp:"post", "post.content.size > 1" %}
+    {% for post in selection %}
       {% include post-list-item.html %}
       {% assign nr_of_posts = nr_of_posts | plus:1 %}
     {% endfor %}

data/bin/install-theme

@@ -0,0 +1,8 @@
+# Create 'posts.md'
+File.write('posts.md', <<~HEREDOC
+  ---
+  layout: posts
+  permalink: posts
+  ---
+  HEREDOC
+)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple-gh-pages-theme
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - LiveNL
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-01 00:00:00.000000000 Z
+date: 2023-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll-archives
@@ -55,12 +55,14 @@ dependencies:
 description:
 email:
 - simple-gh-pages-theme@jordiwippert.nl
-executables: []
+executables:
+- install-theme
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
+- _config.yml
 - _data/navigation.yml
 - _includes/highlights.html
 - _includes/intro.html
@@ -72,11 +74,14 @@ files:
 - _layouts/404.html
 - _layouts/category-posts.html
 - _layouts/default.html
+- _layouts/home.html
 - _layouts/index.html
+- _layouts/page.html
 - _layouts/post.html
 - _layouts/posts.html
 - _sass/main.scss
 - assets/css/main.scss
+- bin/install-theme
 homepage: https://github.com/LiveNL/simple-gh-pages-theme
 licenses:
 - MIT