paginator: add explanatory comments

1 files changed, 8 insertions, 0 deletions

diff --git a/_includes/common/paginator.html b/_includes/common/paginator.html
index d132066..659ea87 100644
--- a/_includes/common/paginator.html
+++ b/_includes/common/paginator.html
@@ -1,4 +1,12 @@
+{% comment %}
+  Page links, inspired by the example at the bottom of
+  https://jekyllrb.com/docs/pagination/.
+{% endcomment %}
 {% if site.posts.size != 0 %}
+  {% comment %}
+    Link to page 1 is tricky. If site.paginate_path is used, then we cannot
+    simply use /. This is a silly attempt to get the proper page 1 link.
+  {% endcomment %}
   {% if paginator.page == 1 %}
     {% assign page1_url = page.url %}
   {% else %}