Add Tag index page

[creeperyang]

Add tag index page generation for hexo-generator-tag.

After generation, it would be like:

public--
       |--tags--
                |----index.html (added)
                |----xxx

So like /tag menu will be supported.

[Xuanwo]

will it override my tags new?

[creeperyang]

No, just append to your generated pages or do nothing, controlled via tag_generator option:

tag_generator:
  per_page: 10
  # append index page or do nothing
  enable_index_page: true/false
  # if enable_index_page: true, config template to use. ['tagIndex', 'tag', 'archive', 'index']
  template: 'tagIndex' 

[tommy351]

LGTM 👍

[tommy351]

You can use:

[].concat(tagConfig.template, ['tagIndex', 'tag', 'archive', 'index']);

In this way, users will still have the template fallback when the template does not exist. Also I think tag-index would be better than tagIndex.

[creeperyang]

Your suggestion seems to be better. :)

[creeperyang]

@tommy351 I make a change after look through the source code of archive and category generator. And now, there is only one config option enable_index_page: true/false.

For template, it's of a particular sequence ['tag-index', 'tag', 'archive', 'index'].

[borisschapira]

+1

[borisschapira]

@creeperyang I would like to use it but I can't manage to understand how to do it. Could you please explain ?

I've set this in configuration :

tag_generator:
  enable_index_page: true
  # if enable_index_page: true, config template to use. ['tagIndex', 'tag', 'archive', 'index']
  template: 'tagIndex' 

And added a tagIndex.ejs to my theme's supported layout. Anything else ?

[creeperyang]

@borisschapira A little change done and now it's stable(merged). So currently the config is like:

tag_generator:
  per_page: 10
  # append index page or do nothing ------ the only config option
  enable_index_page: true/false
  # template: 'tagIndex' ------ removed, default to 'tag-index', so use 'tag-index.ejs' instead.

And the variables inserted into the template(tag-index) are like:

{
        base: tagDir,
        total: 1,
        current: 1,
        current_url: tagDir,
        posts: locals.posts, // all posts
        prev: 0,
        prev_link: '',
        next: 0,
        next_link: '',
        tags: tags // all tags
 }

Last, I check via npm info hexo-generator-tag and @tommy351 hasn't made a new release. So you have to clone the repo if you want to use now.

[borisschapira]

Thanks for the answer, it works.

Maybe you should Pull-Request some evolution to the documentation with all of that info.

Last, I check via npm info hexo-generator-tag and @tommy351 hasn't made a new release. So you have to clone the repo if you want to use now.

✋ You can reference the repo like that to get last commit on master 😄

  "dependencies": {
    ...
    "hexo-generator-tag": "hexojs/hexo-generator-tag",
    ...
}

[borisschapira]

@creeperyang Do you plan to do the same with hexojs/hexo-generator-category ? If yes, maybe you should harmonize the structure of data passed to tag-index to allow the use of a master template (taxonomy-index ?) allowing the listing of tags or categories, regarding the route.

[borisschapira]

@creeperyang : another note : you list all the tags, including the tags of non-published drafts (therefor, the tag page does not necessarily exists). I suggest you filter on tag.length.

[borisschapira]

@creeperyang : and maybe also add a configuration for desired order (alpha, length, reverse...).

[creeperyang]

@borisschapira Good suggestions. But currentlly I have no time to do it. And I use issues to write blog now. Maybe it's a common demand to generate index page for tag and category, I'll fulfill it if the maintainers wont do it.