https://github.com/hugo-fixit/cmpt-santa-hat
A Christmas Easter Egg by JavaScript.
https://github.com/hugo-fixit/cmpt-santa-hat
hugo hugo-fixit theme-component
Last synced: 6 months ago
JSON representation
A Christmas Easter Egg by JavaScript.
- Host: GitHub
- URL: https://github.com/hugo-fixit/cmpt-santa-hat
- Owner: hugo-fixit
- License: mit
- Created: 2025-12-24T03:31:47.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-12-25T04:42:33.000Z (6 months ago)
- Last Synced: 2025-12-25T18:23:40.334Z (6 months ago)
- Topics: hugo, hugo-fixit, theme-component
- Language: HTML
- Size: 18.6 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.en.md
- License: LICENSE
Awesome Lists containing this project
README
🎄 Santa Hat | FixIt
A Christmas Easter Egg by JavaScript.
简体中文 |
繁體中文 |
English |
Français |
Русский язык |
Español |
हिन्दी |
deutsch |
한국어 |
しろうと
## Features
- 🎅 Automatically adds Santa hat decoration to site logos during Christmas season (December 20-26)
- 🎯 Automatic date detection, no manual toggling required
- 💫 Lightweight implementation with no performance impact
## Requirements
- FixIt v0.4.0 or later.
## Install Component
The installation method is the same as [installing a theme](https://fixit.lruihao.cn/documentation/installation/). There are several ways to install, choose one, Here are two mainstream ways.
### Install as Hugo Module
First make sure that your project itself is a [Hugo module](https://gohugo.io/hugo-modules/use-modules/#initialize-a-new-module).
Then add this theme component to your `hugo.toml` configuration file:
```toml
[module]
[[module.imports]]
path = "github.com/hugo-fixit/FixIt"
[[module.imports]]
path = "github.com/hugo-fixit/cmpt-santa-hat"
```
On the first start of Hugo it will download the required files.
To update to the latest version of the module run:
```bash
hugo mod get -u
hugo mod tidy
```
### Install as Git Submodule
Clone [FixIt](https://github.com/hugo-fixit/FixIt) and this git repository into your theme folder and add it as submodules of your website directory.
```bash
git submodule add https://github.com/hugo-fixit/FixIt.git themes/FixIt
git submodule add https://github.com/hugo-fixit/cmpt-santa-hat.git themes/cmpt-santa-hat
```
Next edit `hugo.toml` of your project and add this theme component to your themes:
```toml
theme = ["FixIt", "cmpt-santa-hat"]
```
## Configuration
In order to Inject the partial `santa-hat.fixit.html` into the `custom-assets` through the [custom block](https://fixit.lruihao.cn/references/blocks/) opened by the FixIt theme in the `layouts/_partials/custom.html` file, you need to fill in the following necessary configurations:
```toml
[params]
[params.customPartials]
# ... other partials
assets = [
"inject/santa-hat.fixit.html",
]
# ... other partials
```
## Styling
- Recommended logo size: 32x32 pixels.
- CSS variables:
- `--fi-santa-hat-offset`: Controls hat translation relative to the logo, default `8px 2px`.
- `--fi-santa-hat-shadow`: Controls hat shadow RGB values, default `0, 0, 0`; automatically switches to `255, 255, 255` in dark mode.