eleventy-plugin-shortlinks
v0.2.0
Published
Eleventy plugin to create shortlinks and redirects for items in collections based on Whistle
Downloads
3
Maintainers
Readme
eleventy-plugin-shortlinks
Description
A plugin for Eleventy to generate shortlinks for all items in a collection. The shortlinks can then be paired with a short domain and be used to share shorter permalinks to content in your site.
The shortlinks are generated similar to Whistle which takes the date
of the item in the collection and converts it to NewBase60. The shortlink is traditionally expected to be of the format tSSSn
where:
t
: prefixSSS
: item date in NewBase60n
: number of post in the sameSSS
Installation
npm install eleventy-plugin-shortlinks
Usage
const shortlinks = require('eleventy-plugin-shortlinks')
module.exports = eleventyConfig => {
eleventyConfig.addPlugin(shortlinks, {
startIndex: 0,
prefix: 'i'
})
...
}
The above will generate the shortlinks for all the items in the collections. In order to use it, create another template file (e.g. links.njk
):
---
pagination:
data: collections.all
size: 1
alias: item
permalink: "{{ item.url | shortlink }}/"
eleventyExcludeFromCollections: true
---
{% page_redirect item.url %}
Options
| Option | Description | Default |
| --- | --- | --- |
| startIndex
| Index to start entries for a given day | 0 |
| prefix
| Prefix for all shortlinks (see: design) | empty string
|