https://github.com/yegor256/jekyll-shorts

Automatic generator of short links for all Jekyll pages
https://github.com/yegor256/jekyll-shorts

jekyll jekyll-plugin ruby shortener url-shortener

Last synced: 3 months ago
JSON representation

Automatic generator of short links for all Jekyll pages

• Host: GitHub
• URL: https://github.com/yegor256/jekyll-shorts
• Owner: yegor256
• License: mit
• Created: 2024-02-07T06:39:23.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-10-01T15:46:43.000Z (4 months ago)
• Last Synced: 2024-10-08T08:42:01.605Z (4 months ago)
• Topics: jekyll, jekyll-plugin, ruby, shortener, url-shortener
• Language: Ruby
• Homepage: https://rubygems.org/gems/jekyll-shorts
• Size: 85.9 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![rake](https://github.com/yegor256/jekyll-shorts/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/jekyll-shorts/actions/workflows/rake.yml)

[![Gem Version](https://badge.fury.io/rb/jekyll-shorts.svg)](http://badge.fury.io/rb/jekyll-shorts)

If you have a [Jekyll](https://jekyllrb.com/) static site, this plugin may help you automatically

generate short links for every page. I'm using this plugin for 

[my blog](https://github.com/yegor256/blog).

Install it first (you need [Ruby 3+](https://www.ruby-lang.org/en/news/2020/12/25/ruby-3-0-0-released/) 

and [Jekyll 3+](https://jekyllrb.com/)):

```

$ gem install jekyll-shorts

```

Then, add this to `_config.yml`:

```yaml

plugins:

  - ... your other plugins here ...

  - jekyll-shorts

shorts:

  permalink: :year:month:day:letter.html

```

Here, every page in the site will get a sibling with the name 

`:year:month:day.html`, which will redirect to the page itself. You can use:

  * `:year` - the short form of the year of the post, like `23` or `76`

  * `:month` - the month of the post, like `01` or `12`

  * `:day` - the day of the post, like `07` or `29`

  * `:letter` - a unique English letter for a short URL, like `a`, `b`, etc.

If you don't use the `:letter`, you may end up with duplicated URLs. For example,

you have two pages written in 2023-11-23. Their URLs will be the same, if the 

`permalink` is `:year:month:day.html`, as in the example above. With the help of the `:letter`,

two URLs become different.

Inside the Jekyll page, you can use `{{ page.short-url }}` for the value of the short URL.

## How to Contribute

Make a fork and then test it locally like this:

```bash

$ bundle update

$ bundle exec rake

```

If it works, make changes, test again, and then submit a pull request.