Please follow the instructions below to finish the setup of your new L1nkr site.

0. Add a LICENSE to your repo.
1. Clone your version of the template to your local computer:

git clone https://github.com/Ipad-pc/Linkr

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

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://Ipad-pc.github.io/Linkr'
title: 'L1nkr'

params.yaml:

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

author:
  name: Ipad-pc
  image: author.png
  greeting: "Your new L1nkr site :tada:"
  icon: ":wave:" # outcomment (or remove) if you don't want to display the emoji


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

links:
  - github: https://github.com/Ipad-pc/Linkr
  - link: https://github.com/Ipad-pc/Linkr#readme

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

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

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

# add the icon name to each icon
icontext: true

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

# add tooltips on all icons
tooltip: true

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

title: Linkr
description: "Demo site build with L1nkr & Hugo"
images:
  - thumbnail.png

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

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 square as possible for the best result. Don't use spaces in the filename! 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.

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/[email protected]

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.

You can very easily deploy your site using Github Pages. Included in this template is a Github Action workflow that will build and deploy your site to Github Pages automatically:+1:

You can find the workflow here .github/deploymentWorkflow/buildDeploy.yml. To use this, move it to .github/workflows/.

The workflow is already set up and ready to go, but go through it and spend some time to understand what's going on. Otherwise, it'll always be this black box of magic that you can't fix when it breaks!

Last step: Go to Settings -> Pages -> Build and deployment -> Set the Source to "Github Actions".

Next time you publish a release this workflow will build and deploy your site 🎉

Your site will be published to the following URL: https://Ipad-pc.github.io/Linkr