hugo-neko

A Hugo module that adds a cat that follows your mouse pointer around the page; it leverages oneko.js to include the accompanying JavaScript logic and the GIF image.

Original oneko.js script author: Ariana @ https://adryd.com, https://github.com/adryd325/oneko.js

Brief history of Neko: https://eliotakira.com/neko/

Installation

0. (If you have not already done so)

hugo mod init <your site>
hugo mod tidy

1. Get the latest version

hugo mod get github.com/ystepanoff/hugo-neko@latest

2. Import the module

Edit your site's hugo.toml (or hugo.yaml/hugo.json depending on your configuration format) to import the module.

hugo.toml

[module]
    [[module.imports]]
        path = "github.com/ystepanoff/hugo-neko"

hugo.yaml

module:
  imports:
    - path: "github.com/ystepanoff/hugo-neko"

hugo.json

{
  "module": {
    "imports": [
      {
        "path": "github.com/ystepanoff/hugo-neko"
      }
    ]
  }
}

3. Initialise Hugo modules

hugo mod tidy

Usage

1. As a partial

{{ partial "hugo-neko/oneko.html" . }}

2. As a shortcode

{{< oneko >}}

Updating to the latest version

hugo mod get -u github.com/ystepanoff/hugo-neko@latest

Contact

For any questions, issues, or feature requests, please open an issue.