Update README and exampleSite

This commit is contained in:
Alex Selimov 2026-03-20 09:00:56 -04:00
parent 460fe6a820
commit 41c217030c
3 changed files with 43 additions and 17 deletions

View file

@ -1,7 +1,6 @@
# ᕦʕ •ᴥ•ʔᕤ Bear Cub
# ᕦʕ •ᴥ•ʔᕤ Voting Bear Cub
[![github pages](https://github.com/clente/hugo-bearcub/actions/workflows/gh-pages.yml/badge.svg)](https://github.com/clente/hugo-bearcub/actions/workflows/gh-pages.yml)
[![MIT license](https://img.shields.io/github/license/clente/hugo-bearcub)](https://github.com/clente/hugo-bearcub/blob/main/LICENSE)
[![MIT license](https://img.shields.io/badge/license-MIT-blue)](https://forge.alexselimov.com/aselimov/hugo-bearcub/src/branch/main/LICENSE)
## Overview
@ -9,6 +8,22 @@
Blog](https://bearblog.dev) and [Hugo Bear
Blog](https://github.com/janraasch/hugo-bearblog).
This is a fork of [Bear Cub](https://github.com/clente/hugo-bearcub) with the
following additions:
- **Anonymous post upvoting**: each post can display an upvote button backed by
a configurable API endpoint. Votes are tracked anonymously via cookies so
readers can toggle their vote without creating an account. Enable with
`upvotes = true` and set `upvoteApi` to your API base URL.
- **Redesigned header**: the site header now uses a mesh SVG background for a
more distinctive look.
- **GitHub light/dark color scheme**: the syntax highlighting palette has been
replaced with colors matching the GitHub light and dark themes.
- **Herman CSS upvote styles**: upvote button styles are bundled into the Herman
CSS variant so the button integrates cleanly with the existing theme.
- **Configurable index post count**: use `postsToShowOnIndex` in `[params]` to
control how many posts appear on the home page (defaults to 3).
**Bear Cub** takes care of speed and optimization, so you can focus on writing
good content. It is free, multilingual, optimized for search engines,
no-nonsense, responsive, light, and fast. Really fast.