L1nkr - Simple LinkTree Hugo Theme

L1nkr is a simple LinkTree type Hugo theme. The theme is designed mobile-first, with a very intuitive interface. Get your L1nkr site up and running quickly by using the L1nkr template.

Features

• Simple LinkTree theme, designed for mobile-first.
• Automatic dark mode (based on system setttings).
• Colorful or monochromatic link color scheme.
• Emoji support for a fun design.
• More than 40 supported brand links.
• Healthcheck endpoint (/healthcheck.json).

---

Installation

1. Make sure you have Hugo and Go installed on your local machine. Read the instructions here.
2. Follow this link to the theme template.
3. Follow the installation instructions in the template repo. They are listed below for reference.

Template installation instructions (Only for reference)

1. Use this template by pressing Use this template.
2. Clone your version of the template to your local computer:

git clone https://github.com/<username>/<reponame>

3. Change the module name to match your github repo in go.mod.
4. Modify config/_default/hugo.yaml and config/_default/params.yaml according to the Configuration below.
5. In a terminal/commandline window, move to the newly created folder using cd.
6. Build a local version of your site by executing hugo server. You can see the site by navigating to localhost:1313 (actual URL will be outputted in the CLI) in a browser.
7. Add a new image to the assets/ folder, using the same name as you specified in params.yaml.
8. Add a new icon.png file to update the favicon. The png file should be 512px by 512px in size.

---

Configuration

All configuration is done in the two configuration files under config/_default/. The URL and site title can be set in hugo.yaml, all other parameters are set in params.yaml.

hugo.yaml:

baseURL: 'https://username.github.io/L1nkr'
title: 'L1nkr'

params.yaml:

############################
## Author
############################

author:
  name: "L1nkr"
  image: "author.jpeg"
  greeting: "A simple LinkTree theme for Hugo :evergreen_tree:"
  icon: ":wave:" # outcomment (or remove) if you don't want to display the emoji

############################
## Links
############################

links:
  - github: https://github.com/username/
  - facebook: https://facebook.com/

############################
## Colunms of Links
############################

# between 2 & 6 columns are supported (both incl)
columns: 2

##############################
## Monochromatic color scheme
##############################

# all links will be slate-700 (or slate-50 in dark mode)
# https://tailwindcss.com/docs/customizing-colors
monochrome: true

###########################
## Icon text
###########################

# add the icon name to each icon
icontext: true

############################
## Tooltips
############################

# add tooltips (on hover) to all icons
tooltip: true

###############################
## OpenGraph & Twitter Cards
###############################

title: L1nkr
description: Demo site build with L1nkr & Hugo
images:
  - thumbnail.jpeg

Links are defined by the name (i.e. "github" or "facebook"). The names must match one of the supported link icons, see list below.

Supported Link Icons

Supported Links	Supported Links	Supported Links	Supported Links
amazon	apple	bandcamp	bitbucket
bluesky	check-mark	codepen	dev
discord	dribbble	email	etsy
facebook	flickr	foursquare	github
gitlab	google	instagram	keybase
kickstarter	link	linkedin	mastodon
medium	orcid	patreon	paypal
reddit	signal	skype	slack
snapchat	soundcloud	spotify	stack-exchange
stack-overflow	strava	telegram	tiktok
tumblr	twitch	untappd	website
whatsapp	windows	x-twitter	youtube

Custom Link Icons

Users can provide their own icons by placing a .svg image in ./assets/icons/ in their own repo. Creating folders when necessary. The image should be as circular as possible for the best result. Don't use spaces in the filename! Find all current icons here. If you're using the colorful color scheme, the background color will be the tailwind color bg-indigo-500 (#6366f1) unless another color is specified. This can be done by placing the following css snippet in ./assets/css/custom.css:

.link-nameOfIcon {
  background-color: #6366f1; /* Hex color code */
}

Where nameOfIcon is be the name of the custom .svg file.

SVG Icon Cheatsheet

Make sure that your custom svg icons doesn't have a fixed size. I.e. set the width and height to:

<svg width="100%" height="100%">

And make sure the icon doesn't have any style elements that defines the color!

---

Update the Theme Version

This guide is left here for reference. Please check the template repo for the most up-to-date documentation.

The theme version used to build the site is defined in go.mod file.

The best practice is to update to released and tested versions. To update to a specific version execute the following command in a terminal/commandline (at the root path of your site repo):

  hugo mod get github.com/Chrede88/L1nkr@vX.Y.Z

Replace X,Y & Z with the corresponding version numbers. You can find the releases here. Please check if any breaking changes are listed under the release you want to update to, before proceeding.