https://github.com/moshfeu/github-pages-tags

A package to generate tags views to github pages website
https://github.com/moshfeu/github-pages-tags

github-pages jekyll nodejs npm tags typescript webpack

Last synced: about 1 month ago
JSON representation

A package to generate tags views to github pages website

• Host: GitHub
• URL: https://github.com/moshfeu/github-pages-tags
• Owner: moshfeu
• License: mit
• Created: 2018-10-02T16:25:42.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-12-11T21:57:43.000Z (about 6 years ago)
• Last Synced: 2024-12-07T15:43:40.057Z (about 1 month ago)
• Topics: github-pages, jekyll, nodejs, npm, tags, typescript, webpack
• Language: TypeScript
• Size: 28.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![https://nodei.co/npm/github-pages-tags.png?downloads=true&downloadRank=true&stars=true](https://nodei.co/npm/github-pages-tags.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/github-pages-tags)

[![HitCount](https://hits.dwyl.com/moshfeu/github-pages-tags.svg)](https://hits.dwyl.com/dwyl/start-here)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/moshfeu/github-pages-tags/issues)

## Introduction

You are display tags list on each post in your github pages website and this is good.


But, usually, you want that those tags will be links to a tag page which will display all the posts

which contains the tag, right?


The problem is that `jekyll` is a static "language" so you have to generate each page as static file.


Will you do this manually? I don't think so.

## How it works?

After the package have been installed, this package modify the `package.json` and add to it a postcommit script.


This script is reading all the tags in the site and generate a `.md` file for each of them under `/tags` folder.

## Installation

#### Step 1

```shell

npm install github-pages-tags --save

```

#### Step 2

create a _tag.html_ in _layout_ folder which will be the tag template.

This file should looks like:

```ruby

---

layout: default

---

`{{ page.title }}` posts




  {% for post in site.posts %}

    {% if post.tags contains page.title %}

      {% include post-item.html post=post last=forloop.last %}

    {% endif %}

  {% endfor %}



```


#### Step 3 (optinal)

You can custom the plugin behavior by creating ~~`github-pages-tags.config.js`~~ `github-pages-tags.config.json`.

Here are the options:

```js

{

  // tag page title

  "title": "{{tag}}}",

  // tag page meta description

  "description": "Here are all the posts that related to {{tag}}",

  // generate only tag who have more than `minPostCount` posts. See link below:

  "minPostCount": 0

}

```

### Notes

- `{{tag}}` will be replaced by the actuall tag name.

- `minPostCount` - (Why is good?)