Merge pull request #8 from vsoch/add/tags

Adding tags syndication page and documentation for how to use it

Author: vsoch

CHANGELOG.md

@@ -14,6 +14,7 @@ Critical items to know are:
  - changed behaviour
 
 ## [master](https://github.com/vsoch/docsy-jekyll/tree/master)
+ - tags page and option to link to it from post/docs tags (0.0.12)
  - adding search endpoint tags to docs (0.0.11)
  - adding site.url to config, making links in readme absolute (0.0.1)
  - start of theme  (0.0.0)

VERSION

@@ -1 +1 @@
-0.0.11
+0.0.12

_config.yml

@@ -55,9 +55,9 @@ color: "#30638e"
 # Build settings
 markdown: kramdown
 
-# If you add tags to pages, you can link them to some external search
-# If you want to disable this, comment the URL.
-tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q=
+# If you add tags to pages, define this variable to link them to some external search
+# If you want to link to tags locally on the site, leave this commented out
+# tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q=
 tag_color: primary # danger, success, warning, primary, info, secondary
 
 accentColor: red # purple, green, etc.

_data/toc.yml

@@ -15,6 +15,8 @@
       children:
         - title: Quizzes
           url: "docs/extras/example-quiz"
+        - title: Tags Page
+          url: "tags"
     - title: "About"
       url: "about"
     - title: "News"

_docs/getting-started.md

@@ -353,8 +353,7 @@ and then add them to the navigation by adding to the content of [_data/toc.yml](
 
 #### Tags
 
-If you include tags on a page, by default they won't link to anything. However,
-if you define a `tag_search_endpoint` url in your configuration file, by clicking
+If you include tags on a page, by default they will link to the [tags page]({{ site.url }}{{ site.baseurl }}/tags) on the site. However, if you define a `tag_search_endpoint` url in your configuration file, by clicking
 the tag, the user will be taken to this page to search for it. As an example,
 we define the current search endpoint to be Ask Cyberinfrastructure, and
 page tags link to a search on it:
@@ -375,4 +374,11 @@ tags:
 ```
 
 They are appended to the first h1 block, so generally your pages should have a header.
+If you comment out this variable, then each of your tags will link to it's appropriate
+spot on the tags page linked above.
+
+```yaml
+#tag_search_endpoint: https://ask.cyberinfrastructure.org/search?q=
+tag_color: primary # danger, success, warning, primary, info, secondary
+```
 

_includes/tags.html

@@ -1,2 +1,2 @@
-{% if site.tag_search_endpoint %}{% if page.tags %}<script>
-$('h1').first().append('<div>{% for tag in page.tags %}<span style="font-size:12px" class="badge badge-{{ site.tag_color }}"><a style="cursor:pointer; color:white" href="{{ site.tag_search_endpoint }}{{ tag }}">{{ tag }}</a></span>{% endfor %}</div>')</script>{% endif %}{% endif %}
+{% if page.tags %}<script>
+$('h1').first().append('<div>{% for tag in page.tags %}<span style="font-size:12px" class="badge badge-{{ site.tag_color }}"><a style="cursor:pointer; color:white" href="{% if site.tag_search_endpoint %}{{ site.tag_search_endpoint }}{{ tag }}{% else %}{{ site.url }}{{ site.baseurl }}/tags#{{ tag }} {% endif %}">{{ tag }}</a></span>{% endfor %}</div>')</script>{% endif %}

pages/tags.html

@@ -0,0 +1,21 @@
+---
+title: Tags Index
+permalink: /tags/
+---
+
+<h1 id="tags-index">Tags Index</h1>
+{% capture site_tags %}{% for tag in site.tags %}{% if tag %}{{ tag | first }}{% unless forloop.last %},{% endunless %}{% endif %}{% endfor %}{% endcapture %}{% assign docs_tags = "" %}{% for doc in site.docs %}{% assign ttags = doc.tags | join:',' | append:',' %}{% assign docs_tags = docs_tags | append:ttags %}{% endfor %}
+{% assign all_tags = site_tags | append:docs_tags %}{% assign tags_list = all_tags | split:',' | uniq | sort %}
+
+{% for tag in tags_list %}{% if tag %}<h3 id="{{ tag | replace: '/', '-' }}" class="linked-section">{{ tag }}</h3>
+<div class="post-list" style="margin-bottom:40px">
+    {% for post in site.tags[tag] %}<div class="tag-entry">
+    <a href="{{- site.url -}}{{- post.url -}}">{{- post.title -}}</a>
+    <time style="font-style:italic; float:right" datetime="{{- post.date | date_to_xmlschema -}}"> {{- post.date | date: "%B %d, %Y" -}}</time>
+</div>{%- endfor -%}
+{% for doc in site.docs %}{% if doc.tags contains tag %}
+<div class="tag-entry">
+    <a href="{{- site.baseurl -}}{{- doc.url -}}">{{ doc.title }}</a>
+        <time style="font-style:italic; float:right" datetime="{{- doc.date | date_to_xmlschema -}}"> {{- doc.date | date: "%B %d, %Y" -}}</time>
+    </div>{% endif %}{% endfor %}
+</div>{% endif %}{%- endfor -%}