ᕦʕ •ᴥ•ʔᕤ Bear Cub

Overview

🐻 A lightweight Hugo theme based on Bear Blog and Hugo Bear Blog.

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.

Installation

Follow Hugo's quick start to create an empty website and then clone Bear Cub into the themes directory as a Git submodule:

git submodule add https://github.com/clente/hugo-bearcub themes/hugo-bearcub

To finish off, append a line to the site configuration file:

echo 'theme = "hugo-bearcub"' >> config.toml

Features

Like Bear Blog, this theme:

Is free and open source
Looks great on any device
Makes tiny (~5kb), optimized, and awesome pages
Has no trackers, ads, or scripts
Automatically generates an RSS feed

But that's not all! Bear Cub is also...

Accessible

Bear Cub has a few accessibility upgrades when compared to its predecessors. The color palette has been overhauled to make sure everything is readable for users with low vision impairments or color deficiencies, and some interactive elements were made bigger to facilitate clicking for users with a motor impairment.

These small changes mean that Bear Cub passes Google's PageSpeed test with flying colors.

Secure

Bear Cub's demo is hosted on GitHub and therefore I'm not in control of its Content Security Policy. However, the theme itself was made with security in mind: there are no inline styles and it uses no JavaScript at all.

If you want to improve your Mozilla Observatory score even further, you should be able to simply add a few headers to your hosting service's configuration (e.g. Netlify or Cloudflare Pages) and never have to think about it again. My _headers file, for example, looks like this:

/*
  X-Content-Type-Options: nosniff
  Strict-Transport-Security: "max-age=31536000; includeSubDomains; preload" env=HTTPS
  Cache-Control: max-age=31536000, public
  X-Frame-Options: deny
  Referrer-Policy: no-referrer
  Feature-Policy: microphone 'none'; payment 'none'; geolocation 'none'; midi 'none'; sync-xhr 'none'; camera 'none'; magnetometer 'none'; gyroscope 'none'
  Content-Security-Policy: default-src 'none'; manifest-src 'self'; font-src 'self'; img-src 'self'; style-src 'self'; form-action 'none'; frame-ancestors 'none'; base-uri 'none'
  X-XSS-Protection: 1; mode=block

Multilingual

If you need to write a blog that supports more than one language, Bear Cub has you covered! Check out the demo's config.toml file for a sample of how you can setup multilingual support.

By default, the theme creates a translation button that gets disabled when the current page is only available in any other language. You can also choose to hide this button (instead of disabling it) by setting hideUntranslated = false.

Every once in a while, as I keep using Bear Cub, I notice that there is some functionality missing. Currently, these are the "advanced features" that I have already implemented:

Static content: you can create empty blog entries that act as links to static files by including link: "{url}" in a post's front matter.
Single-use CSS (EXPERIMENTAL): you can add some styles to a single page by writing the CSS you need in assets/{custom_css}.css and then including style: "{custom_css}.css" in the front matter of said page.
Dynamic social card generation (EXPERIMENTAL): if you don't add preview images to a post, this template will generate one based on the title. You can see an example below.

Configuration

Bear Cub can be customized with a config.toml file. Check out the configuration of the demo for more information.

# Basic config
baseURL = "https://example.com"
theme = "hugo-bearcub"
copyright = "John Doe (CC BY 4.0)"
defaultContentLanguage = "en"

# Generate a nice robots.txt for SEO
enableRobotsTXT = true

# Your name. For more information on why this must be a list, see
# https://discourse.gohugo.io/t/site-author-usage/31459/8
[author]
  name = "John Doe"

# Setup syntax highlighting without inline styles. For more information about
# why you'd want to avoid inline styles, see
# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/style-src#unsafe_inline_styles
[markup]
  [markup.highlight]
    lineNos = true
    lineNumbersInTable = false
    # This allows Bear Cub to use a variation of Dracula that is more accessible
    # to people with poor eyesight. For more information about color contrast
    # and accessibility, see https://web.dev/color-and-contrast-accessibility/
    noClasses = false

# Multilingual mode config. More for information about how to setup translation,
# see https://gohugo.io/content-management/multilingual/
[languages]
  [languages.en]
    title = "Bear Cub"
    languageName = "en-US 🇺🇸"
    LanguageCode = "en-US"
    contentDir = "content"
    [languages.en.params]
      blogPath = "/blog" # Path to your blog section (used by RSS)
      madeWith = "Made with [Bear Cub](https://github.com/clente/hugo-bearcub)"
  [languages.pt]
    title = "Bear Cub"
    languageName = "pt-BR 🇧🇷"
    LanguageCode = "pt-BR"
    contentDir = "content.pt"
    [languages.pt.params]
      blogPath = "/pt/blog" # Path to your blog section (used by RSS)
      madeWith = "Feito com [Bear Cub](https://github.com/clente/hugo-bearcub)"

[params]
  # The description of your website
  description = "Bear Cub Demo"

  # The path to your favicon
  favicon = "images/favicon.png"

  # These images will show up when services want to generate a preview of a link
  # to your site. Ignored if `generateSocialCard = true`. For more information
  # about previews, see https://gohugo.io/templates/internal#twitter-cards and
  # https://gohugo.io/templates/internal#open-graph
  images = ["/hugo-bearcub/images/share.webp"]

  # This title is used as the site_name on the Hugo's internal opengraph
  # structured data template
  title = "Bear Cub"

  # Dates are displayed following the format below. For more information about
  # formatting, see https://gohugo.io/functions/format/
  dateFormat = "2006-01-02"

  # If your blog is multilingual but you haven't translated a page, this theme
  # will create a disabled link. By setting `hideUntranslated` to true, you can
  # have the theme simply not show any link
  hideUntranslated = false

  # (EXPERIMENTAL) This theme is capable of dynamically generating social cards
  # for posts that don't have `images` defined in their front matter; By setting
  # `generateSocialCard` to false, you can prevent this behavior. For more
  # information see layouts/partials/seo_tags.html
  generateSocialCard = true

  # Social media. Delete any item you aren't using to make sure it won't show up
  # in your website's metadata.
  [social]
    email = "me@example.com" # Added to the navbar so readers can reply to posts
    twitter = "example" # Twitter handle (without '@')
    facebook_admin = "0000000000" # Facebook Page Admin ID

Contributing

If you come across any problems while using Bear Cub, you can file an issue or create a pull request.

kangminsukdotcom/hugo-bearcub