Last year's posts wrongly identified as this year's post ?Capture nyear?

888ba8 · January 9, 2021, 3:26pm

I am using the following theme Documentation – Documentation + help systems theme – Jekyll Themes and have a post in_posts with the following permalink. No other date indication, so I assume the date is taken from the permalink:

---
permalink: 2020-12-04-something-something.html
---

There is a page called news/news_archive.html as such:

<div class="home">

    <div class="post-list">

    <section id="archive">
        <h3>This year's posts</h3>
        {%for post in site.posts %}
        {% unless post.next %}
        <ul class="this">
            {% else %}
            {% capture year %}{{ post.date | date: '%Y' }}{% endcapture %}
            {% capture nyear %}{{ post.next.date | date: '%Y' }}{% endcapture %}
            {% if year != nyear %}
        </ul>
        <h3>{{ post.date | date: '%Y' }}</h3>
        <ul class="past">
            {% endif %}
            {% endunless %}
            <li><time>{{ post.date | date:"%d %b" }}</time><a href="{{ post.url | remove: "/"}}">{{ post.title }}</a></li>
            {% endfor %}
        </ul>
    </section>
    <hr/>
    </div>
</div>

However, it is 2021 now, the site was last generated/built in 2021 but still in the built website the post is shown under This year’s posts. Why please?

Should it not be visible under another section, namely last year’s posts?

What could be wrong or how can I troubleshoot this? In the original theme’s demo, there is a differentiation between the years:

https://idratherbewriting.com/documentation-theme-jekyll/news_archive.html

MichaelCurrin · January 9, 2021, 9:07pm

The code above lumps everything together as This year.

It does not even check what the current year is and whether to show post. But that is okay.

If that snippet is in the theme then you should copy the file to your own repo but edit it.

Take out the first H3 about “this year’s posts”. That heading is inaccurate and not useful (especially if you most recent post was last year)

See if the rest of the code works for you as is - to group posts by year. No filtering needed.

The indentation makes it hard to reason about but I am figuring out the intention.
The code checks the current post in the loop against the next post (which will be older). If they are not in the same year, then it shows the year only as a kind of heading. See %Y

which gives you a sense of when the year starts and all post under it are the same.

And it always shows the month and day for a post.

888ba8 · January 9, 2021, 9:54pm

Hi @MichaelCurrin. Thanks a lot for your help. I am really lucky to receive your lending of experience and knowledge.

Indeed, as per your comments I now understand better what is going on! Since I had no “this year’s post” last year’s post was stilll showing under “this year’s post”, exactly like you predicted.

Let me try and see if I can fiidle with it according to your suggestions.

888ba8 · January 9, 2021, 9:59pm

@MichaelCurrin I feel the following works fine:

<div class="home">
  <div class="post-list">
    <section id="archive">
      {% for post in site.posts %}
      <h3>{{ post.date | date: '%Y' }}</h3>
      <ul class="past">
        <li><time>{{ post.date | date:"%d %b" }}</time><a href="{{ post.url | remove: "/"}}">{{ post.title }}</a></li>
      </ul>
      {% endfor %}
    </section>
    <hr/>
  </div>
</div>

With regards to the formatting/indentation, please let me know if you know of a good (on-line or offline) tool?

I just ran this last snippet through a HTML beautifier … is that the preferred way when dealing with mixed HTML / Liquid Jekyll code?

Kind regards!

MichaelCurrin · January 10, 2021, 7:21am

Okay good.

What are you removing the / for?

Perhaps your site is on github pages on a sub path so you want to make the URL relative and not start with /

I suggest

{{ post.url | relative_url }}

Which will add repo as a prefix.

/repo-name/2021/01/01/postname.html

If you want to remove trailing slash then look into Permalink.

MichaelCurrin · January 10, 2021, 7:29am

Regarding formatting

I use a Jekyll extension on VS Code and set .md and .html files (in a project) to format as “jekyll”. That gives me syntax highlighting.
It does not format for me.

So if I want to format ie prettify, I change to HTML format and then run the formatter (or save).

That generally helps with long lines and getting HTML overall to indent well. Especially if you have a really long and nested snippet that you want spread over multiple lines.

The downside is that items nested in an if statement and or loop are not indented. That might be okay for you. My personal preference is based on Python etc so I indent manually. And switch back to “jekyll” as a format so that it doesn’t auto format HTML.

Using HTML

<div>
    {% for x in y %}
    <p>{{ x }}</p>
    {% endfor %}
</div>

My custom indent added to that.

<div>
    {% for x in y %}
        <p>{{ x }}</p>
    {% endfor %}
</div>

I tried a Liquid extension and setting Liquid as the format. I didn’t like it though

888ba8 · January 10, 2021, 9:35am

Hi @MichaelCurrin

With regards to the removal of / (remove: "/"), I notice that the author of the theme does this continuously. See e.g. the links from the default sidebar file:

github.com

tomjoht/documentation-theme-jekyll/blob/gh-pages/_includes/sidebar.html

{% assign sidebar = site.data.sidebars[page.sidebar].entries %}

<ul id="mysidebar" class="nav">
  <li class="sidebarTitle">{{sidebar[0].product}} {{sidebar[0].version}}</li>
  {% for entry in sidebar %}
  {% for folder in entry.folders %}
  {% if folder.output contains "web" %}
  <li>
      <a title="{{folder.title}}" href="#">{{folder.title}}</a>
      <ul>
          {% for folderitem in folder.folderitems %}
          {% if folderitem.output contains "web" %}
          {% if folderitem.external_url %}
          <li><a title="{{folderitem.title}}" href="{{folderitem.external_url}}" target="_blank" rel="noopener">{{folderitem.title}}</a></li>
          {% elsif page.url == folderitem.url %}
          <li class="active"><a title="{{folderitem.title}}" href="{{folderitem.url | remove: "/"}}">{{folderitem.title}}</a></li>
          {% elsif folderitem.type == "empty" %}
          <li><a title="{{folderitem.title}}" href="{{folderitem.url | remove: "/"}}">{{folderitem.title}}</a></li>

          {% else %}

This file has been truncated. show original

Or the article/keyword search file:

github.com

tomjoht/documentation-theme-jekyll/blob/gh-pages/search.json

---
title: search
layout: none
search: exclude
---

[
{% for page in site.pages %}
{% unless page.search == "exclude" %}
{
"title": "{{ page.title | escape }}",
"tags": "{{ page.tags }}",
"keywords": "{{page.keywords}}",
"url": "{{ page.url | remove: "/"}}",
"summary": "{{page.summary | strip }}"
}
{% unless forloop.last and site.posts.size < 1 %},{% endunless %}
{% endunless %}
{% endfor %}

This file has been truncated. show original

Or the links creation file (I have not well understood this yet):

github.com

tomjoht/documentation-theme-jekyll/blob/gh-pages/_includes/links.html

{% comment %}Get links from each sidebar, as listed in the _config.yml file under sidebars{% endcomment %}

{% for sidebar in site.sidebars %}
{% for entry in site.data.sidebars[sidebar].entries %}
{% for folder in entry.folders %}
{% for folderitem in folder.folderitems %}
{% if folderitem.url contains "html#" %}
[{{folderitem.url | remove: "/" }}]: {{folderitem.url | remove: "/"}}
{% else %}
[{{folderitem.url | remove: "/"  | remove: ".html"}}]: {{folderitem.url | remove: "/"}}
{% endif %}
{% for subfolders in folderitem.subfolders %}
{% for subfolderitem in subfolders.subfolderitems %}
[{{subfolderitem.url | remove: "/"  | remove: ".html"}}]: {{subfolderitem.url | remove: "/"}}
{% endfor %}
{% endfor %}
{% endfor %}
{% endfor %}
{% endfor %}
{% endfor %}

This file has been truncated. show original

On the other hand, there is a portion permalink: … in the pages and posts YAML frontmatter.

Is the code wrong then?

Should I change all instances of | remove: "/" into | relative_url? Thanks for any help making me understand.

MichaelCurrin · January 10, 2021, 9:43am

Yes the code by author is wrong and you should fix it. Removing a forward slash on most URLs anywhere in the URL (ie beginning and middle and end) is very weird and not something that Jekyll sites do.

It might work fine if all your pages are at the same level, but as it will break otherwise.

For example

Given you are on page

/a/b/c.html

And you want to link to

/a/d.html

If your URL is this without any forwardslash it will break.

ad.html

Firstly, it will be a relative URL as ./ad.html
Which means from c.html it will link to

/a/b/c.html/ad.html

Secondly, the / between a and d is important.

Doing this works from anywhere on the site because it is absolute and not relative.

href="/a/d.html"

And if you use relative_url then that will prepend /repo-name, which is needed on GH Pages.

The absolute URL is especially important for assets. As you need to access /css/styles.css an absolute URL from anywhere. If it was css/styles.css in the HTML then the browser would see it as /a/b/c.html/css/styles.css for example.