A metalsmith plugin to create dedicated pages for tags in provided in metalsmith pages.
NOTE: looking for new maintainers of this project. please consult this issue for discussion.
$ npm install metalsmith-tags
Description in Pages
In your pages:
--- title: This is page with tags tags: tagged, page, metalsmith, plugin --- Hello World
You can use different handle for the tags, by configuring the
tags is the default.
Install the node modules and then add the
metalsmith-tags key to your
metalsmith.json plugins. The simplest use case just requires tag handle you want to use:
Pass the plugin to
var tags = ;metalsmith;
This will generate
topics/[tagname].html pages in your
build directory with array of
pagination.files objects on which you can iterate on. You can use
tag for tag name in your layouts. (You can refer to tests folder for tags layout.)
tags property on your pages will remain, but it will be modified to an array of objects containing a
slug property for each tag.
You can use
metalsmith-permalink to customize the permalink of the tag pages as you would do with anything else.
It is possible to use
opts.metadataKey for defining the name of the global tag list.
By default it is
Additionally you can paginate your tag pages. To do so add two additional properties to your configuration object,
perPage, and modify
path to point to the root pagination location:
This will paginate your array of tags so that 6 appear per page, with additional tag pages being nested underneath the first page of tags. For additional details please look at the tests.
Feel free to contribute to this plug-in. Fork, commit, send pull request. Issues, suggestions and bugs are more than welcome.
In case you add functionality, please write corresponding test. Test using