Really, really, really ridiculously good looking splash page for Hugo
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Josh Habdas 56e2b0f1f6
docs($readme): update outline, add external links
8 months ago
archetypes Initial commit 8 months ago
exampleSite chore(release): 0.1.0 8 months ago
images chore(release): 0.1.0 8 months ago
layouts chore(release): 0.1.0 8 months ago
src chore(release): 0.1.0 8 months ago
static chore(release): 0.1.0 8 months ago
.gitignore Initial commit 8 months ago
CHANGELOG.md chore(release): 0.1.0 8 months ago
COPYING Initial commit 8 months ago
README.md docs($readme): update outline, add external links 8 months ago
package-lock.json chore(release): 0.1.0 8 months ago
package.json chore(release): 0.1.0 8 months ago
theme.toml Initial commit 8 months ago

README.md

Seminyak

Really, really, really ridiculously good looking splash page for Hugo.

Installation

  • Copy theme to your site’s themes folder.
  • Set theme = "seminyak" in your config.
  • Make it read good and do other things good too.

Features

  • Customizable full-screen background image
  • Choose from 1 of 10 predefined color palettes
  • Create your own color palette with Tailwind
  • Add custom Web Fonts from Google
  • Easily add your own scripts and favicon
  • Optional image credits display
  • Google Analytics using Hugo’s internal template
  • Open Graph using Hugo’s internal template
  • RSS using Hugo’s internal template (just in case)
  • Add privacy with Referrer Policy
  • Webmaster Verification ready

Customization

Customizing the Web Font

To update the Web Font update google_fonts in the config file and adjust settings in tailwind-custom.js then run npm run build to generate a new stylesheet.

Modify the Color Palette

To adjust the color palette adjust the color setting for color_palette in the site config. To create your own color palette modify tailwind-custom.js and run npm run build from the theme directory. See Coolors for color schemes and the Tailwind docs for how to customize.

Configuration

Just the basics. Add to your site configuration.

googleAnalytics = "UA-123-45" # Optional, enable Google Analytics

[params]
  color_palette = "yellow" # Required, adjusts color palette
  theme_color = "#fffdc3" # Optional, theme-color meta tag
  referrer_policy = "same-origin" # Optional, referrer policy meta tag
  background_image_url = "https://source.unsplash.com/ZJqO6ddBpic/" # Optional, background image
  google_fonts = "Oswald|Raleway" # Passed to Google for Web Font

[params.webmaster]
  google = "" # Optional, Google verification code
  bing = "" # Optional, Bing verification code
  alexa = "" # Optional, Alexa verification code
  yandex = "" # Optional, Yandex verification code

See the Hugo docs for additional configuration options.

Favicon

To add a favicon add a favicon.html file in your site’s partials folder and drop in a link tag with your favicon.

Scripts

To add some scripts do one or both of the following depending on the type of script you wish to add. For asynchronous scripts create a scripts-async.html file in your site’s partials folder and add async scripts there. For blocking scripts create a scripts-blocking.html file in your site’s partials folder and add any blocking scripts there.

License

Copyright 2018 Josh Habdas jhabas@protonmail.com (https://habd.as)
This work is free. You can redistribute it and/or modify it under the
terms of the Do What The Fuck You Want To Public License, Version 2,
as published by Sam Hocevar. See the COPYING file for more details.