Linkbox es un tema diseñado para hugo e inspirado en LinkTree. Es una web rapida y sencilla construida con HTML y CSS que permitira organizar tus enlaces en un solo lugar.

• Requisitos
• Instalación
• Configuración básica
• Enlaces
• Etiquetas metas
• Perfil
• Pie de Pagina
• Personalización

• Local
  1. Instalar hugo.
  2. Instalar Git.
• Remoto
  1. Fork a este repositorio

Linkbox es extremadamente sencillo, desde su instalación hasta su uso, por ello puede implementarlo de la manera que mas le convenga

• Instalación mediante Submodule Git

  1. inicie un nuevo proyecto con HUGO → hugo new site <my-new-site>
  2. muevase dentro de su nuevo proyecto → cd <my-new-site> e inicie git git init
  3. Añada linkbox mediante submodule

   git submodule add https://github.com/deltronik/linkbox.git 'themes/linkbox'

  4. En su archivo de configuración hugo.toml modifique lo siguiente

   baseURL = ''
   title = 'your title site'
   theme = 'linkbox'

• Clonar mediante git

Una alternativa y creo la mas facil, es clonar este repositorio mediante git git clone https://github.com/deltronik/linkbox.git y editar el archivo hugo.toml

• Fork al repositorio

Otra forma aun mas sencilla es directamente hacer fork del reposirio. elimine el archivo netlify.toml, la carpeta exampleSite cree y edité el archivo hugo.toml en la raiz del proyecto

LinkBox puede configurarse completamente desde el archivo hugo.toml, por ello puede iniciar la edición de dicho archivo con la siguientes lineas:

baseURL = "."
# Idioma del sitio
languageCode = "es-es"
# Titulo del sitio
Title = "my-title-site"
# buscadores pueden indexar enlaces del sitio (true or false)
robotsTXT = "true"

Cuando robotsTXT es true hugo genera el archivo robots.txt mediante una plantilla interna. Si usted prefiere utilizar una plantilla personalizada tiene dos opciones:

• primero, puede generar un archivo robots-txt en linkbox/layouts.
• segundo, puede establecer robotsTXT como false y crear el archivo robots.txten linkbox/static/.
• para mas información: aquí.

Para configurar enlaces del menu linkbox respeta la sintaxis tipica de los menus en Hugo.

• Parametros del menu
  1. pre: este permite añadir contenido antes del titulo del item del menu, puede implementar html si asi lo desea por ejemplo añadir un icono de fontawesome
  2. name: es el nombre o titulo que mostrara el item del menu
  3. url: es la dirección a la que se redirigira al presionar el enlace
  4. post: al igual que pre, post permite añadir contenido solo que este lo añade al final, despues del nombre
  5. weight: permite seleccionar la posición en la que se mostrara el item

[menu]
	[[menu.main]]
	pre = "<i class='fa-brands fa-github'></i>"
	name = "github"
	url = "https://github.com"
	post = ""
	weight = 2
	[[menu.main]]
	pre = ""
	name = "github"
	url = "https://github.com"
	post = "<i class='fa-brands fa-github'></i>"
	weight = 1

Linkbox permite configurar algunas etiquetas metas para mejorar el SEO del sitio, estas son opcionales y no necesariamente es obligatorio configurarlas.

[Params]
	description = "Una breve descripción del su sitio web y/o emprendimiento o empresa.."
	keywords  = "Palabras claves para facilitar la busqueda..."
	author = "author del sitio"

Por defecto puede arrojar los archivos del favicon dentro de statics con los nombres preterminados, linkbox los indexara de forma automatica. Por otra parte si quiere una mejor organización, por ejemplo poner el archivo favicon.ico dentro de static/img/favicon/favicon.ico puede configurarlo desde el archivo hugo.toml de la siguiente manera:

[params]
	favicon = "static/img/favicon"

los archivos esperados son los siguientes:

• android-chrome-192x192.png
• android-chrome-512x512.png
• apple-touch-icon.png
• favicon-16x16.png
• favicon-32x32.png
• favicon.ico
• site.webmanifest

No es necesario configurar la ruta para cada archivo individual, linkbox toma la ruta del parametro favicon y la utiliza de forma preterminada con todos los archivos dentro de la carpeta.

recomiendo severamente utilizar el siguiente recurso para crear los favicon favicon generator

| Nota: Preferentemente mantenga los nombres preterminados de los archivos favicon.

Linkbox le permitira conectar fuentes de dos formas

1. Fuentes locales : por defecto la raiz de su proyecto es en 'static', por ello si tiene una fuente tipografica que añadir arrojarla en este directorio y configurar en hugo.toml lo siguiente:

[params]
	local_fonts = [{name="Orbit",file="/orbit.ttf"},{name="name-fonts", file="path"}]

recuerde enfocar siempre al archivo .ttf o cualfuese sea el archivo tipografico siempre teniendo en cuenta que su rais es static, por ejemplo si usted tuviera el archivo en linkbox/static/carpeta_fuenteo mi_sitio_hugo/static/carpeta_fuente la configuración seria la siguiente:

	local_fonts = [{name="Orbit",file="/carpeta_fuente/fuente.ttf"}]

2. Usar la api de Google: Para conectar una fuente desde google fonts puede configurar en el archivo hugo.toml lo siguiente:

[params]
	google_fonts = [["Josefin+Sans","300,700"],["Orbit","400"]]

|Nota: Si el nombre de la fuente tipografica lleva un espacio ' ', remplase el mismo con el simbolo '+'

Si desea configurar una imagen para el avatar puede hacerlo de dos formas.

1. Utilizar gravatar, en el archivo hugo.toml configure su correo electronico en el parametro gravatar de la siguiente forma:

[params]
	[params.header]
	gravatar = "[email protected]"

2. Puede utilizar una imagen local, recuerde siempre que su carpeta raiz es static ,por ende, puede arrojar el archivo de imagen en el directorio y configurar el parametro avatar de la siguiente manera:

[params]
	[params.header]
	avatar = "avatar.jpg"

Si, por alguna casualidad usted necesida que el sitio carge una imagen preterminada para el modo claro y otra para el modo oscuro puede arrojar ambos archivos en static y configurarlos de la siguiente manera:

[params]
	[params.header]
	avatar = "avatar.jpg"
	avatarDark = "avatarDark.jpg"

Puede configurar un nombre o titulo debajo del avatar mediante:

[params]
	[params.header]
	user = "Mi Title/Name"

Si desea configurar una frase, slogan o una simple descripción debajo del avatar puede hacerlo como se muestra a continuación:

[params]
	[params.header]
	paragraph = "this is a description"

Puede mostrar enlaces en forma de iconos debajo si lo desea (aún no esta configurado completamente pero se encuentra en estado funcional) solo debe añadir la red social o plataforma de la que desee mostrar el icono y añadir , en algunos casos, el usuario, en otros debera proveer el enlace directo a su perfil.

    [params.icons]
        github = 'user'
        gitlab = 'user'
        facebook = 'user'
        instagram = 'user'
        x = 'user'
        mastodon = 'user'
        linkedin = 'user'
        youtube = 'chanel'
        pinterest = 'user'
        tiktok = 'user'
        reddit = 'user'
        snapchat = 'user'
        whatsapp = 'number'
        telegram = 'user'
        wordpress = 'url'
        wix = 'url'
        stack_overflow = 'user'
        sound_cloud = 'user'
        spotify = 'user'
        apple_music = 'user'
        bandcamp = 'user'
        vimeo = 'user'
        daylamotion = 'user'
        twitch = 'chanel'

Puede elegir si mostrar o no el pie de pagina, basta con configurar un par de parametros en el archivo hugo.toml

[params]
	[params.footer]
	description = "this is a description"
	license = "MIT"

| Nota: si no configura la licencia se mostrara la licencia de LinkBox Preterminada, si tiene conocimientos de desarrollo web puede editar el archivo `linkbox/layouts/partials/footer.html``

Una cosa no menor es que puede establecer si quiere que la lista de enlaces [menu] se genere antes o despues de la barra de iconos

	[params]
		# true or false 
		order = true

• Si Order es igual a 1 o true, se renderizara la lista de iconos primero y luego la lista de enlaces

	<nav>
		<!-- Social Bar -->
	</nav>

	<nav>
		<!-- List URL -->
	</nav>

• Si Order es igual a 0, false, o directamente ignora escribir el parametro se renderizara primero la lista de enlaces y luego la lista de iconos

	<nav>
		<!-- List URL -->
	</nav>

	<nav>
		<!-- Social Bar -->
	</nav>

LinkBox le permitira editar los archivos css desde el mismo hugo.toml. Puede personalizar (casí) todo con solo algunos parametros.

|Nota: todos lo parametros pueden ser configurados con las unidades de medidas permitidas por css. Para mas información sobre estas unidades puede consultar aquí

[params.style]
	# color de fondo
	backColor = "white"
	# color de fondo modo oscuro (opcional)
	backColorDark = "black"
	# imagen de fondo (recuerde que su carpeta raiz es 'statics')
	backImg = "background.jpg"
	# imagen fondo modo oscuro (opcional)
	backImgDark = "backgroundDark.jpg"

Si establece una imagen de fondo he decidido permitir total control de las propiedades de la misma en css, puede controlar los siguientes parametros:

1. Repetir imagen: utilice repeatImg = "valor" , puede utilizar los valores permitido por css. Aqui puede ver los valores y resultados de cada uno.
2. attachmentImg: puede utilizar los valores scroll, fixed o inherit. Puede ver aqui el resultado de cada opción.
3. positionImg: Permite todos los valores de 'background-position'. Puede ver los valores y resultados aqui.
4. sizeImg: puede utilizar los valores permitidos por css para 'background-size'. Puede ver los valores y resultados aquí.

Puede que su archivo hugo.toml ya deba verse de esta forma:

baseURL = 'https://box.deltronik.net'
languageCode = 'es-es'
title = 'LinkBox'
enableRobotsTXT = true

[menu]
        [[menu.main]]
    	pre = "<i class='fa-brands fa-github'></i>"
        name = 'github'
        url = 'https://github.com/deltronik/linkbox'
        post = ""
    	weight = 1
        [[menu.main]]
        pre = ""
        name = 'licence'
        url = "https://github.com/deltronik/linkbox/LICENSE"
        post = "<i class='fa-solid fa-file-circle-check'></i>"
        weight = 2
[params]
        google_fonts = [["Josefin+Sans","300"]]
        local_fonts = [{name="Orbit", file="Orbit/Orbit-Regular.ttf"}]
[params.header]
        user = "LinkBox"
        paragraph = "Cuando los electrones se mueven las cosas suceden"
        avatar = "img/avatar/avatar.png"
[params.icons]
        github = "deltronik"
        gitlab = "deltronik_"
        x = "deltronik_"
[params.footer]
    	description = "This is a description"
    	creator = true
		license ="MIT"
[params.style]
    	backImg = 'img/background/background.jpg'
		backImgDark = "img/background/background2.jpg"
    	backColor = "white"
    	repeatImg = "no-repeat"
    	attachmentImg = "fixed"
    	positionImg = "center"
    	sizeImg = "cover"

Puede personalizar la cabecera, esto inluye imagen avatar/usuario, iconos, frace y titulo.

Recuerde que puede emplear cualquier valor permitido por css dependiendo el parametro que requiera personalizar (px,em,rgb(0,0,0),#fff,%..) para mas información aquí.

[params.style.user]
	# tamaño de la imagen (puede utilizar cualquier valor permitido por css)
	imgSize = "180px"
	# Radio de la imagen (puede utilizar cualquier valor permitido de css)
	imgRad = "50%"
	# Altura de la imagen (puede utilizar cualquier valor permitido por css)
	topSeparate = "4em"
	# separación entre el titulo/nombre y la imagen
	titleSeparate = "15px"
	# tamaño del titulo/nombre(puede utilizar cualquier valor permitido por css)
	titleSize = "2em"
	# fuente tipografica del titulo
	titleFamily = "Orbit"
	# Color del titulo(puede utilizar cualqueir valor permitido por css)
	titleColor = "#fff"
	# Color del slogan/frase/descripción(puede utilizar cualquie valor permitido por css)
	textColor = "rgb(255, 255, 255)"
	# Separación entre el titulo y frase (puede usar cualquier valor permitido por css)
	textBottomMargin = "10px"
	# familia tipogramica para la frase/slogan
	textFamily = "Orbit"
	# tamaño del texto/frase
	textSize = "1.1em"
[params.style.icons]
	# colores de los iconos(puede utilizar cualquier valor permitido por css)
	color = "black"
	# tamaño de los iconos (puede utlizar cualquier valor permitido por css)
	size = "1.5em"

Puede personalizar tamaño, tipografia, y color de los items del menu a su gusto solo debe añadir los siguientes parametros en hugo.toml

 [params.style.menu]
		# color del texto
        textColor = "white"
		# tamaño del texto
        textSize = "2em"
		# familia tipografica del texto
        textFamily = "Josefin Sans"
		# color de fondo de los items
        itemColor = "black"
		# separación entre items del menu
        itemSeparate = "2em"
		# tamaño de los items
        itemSize = "3em"
		# ancho de los items
        itemWidth = "90%"
		# radio de los items
        itemRad = "15px"

| Nota: Recuerde que si requiere establecer colores para el modo oscuro solo debe agregar 'Dark' al final del parametro (en aquellos que se traten de colores) para establecer un valor. por ejemplo

[params.style.menu]
		textColor = "white"
		textColorDark = "black"
        itemColor = "blue"
        itemColorDark = "red"

[params.style.footer]
		# color de fondo
        backColor = "black"
		# tamaño del pie de pagina (alto)
        footerSize = "auto"
		# tamaño del texto
        textSize = "14px"
		# color del texto
        textColor = "white"
		# ancho del pie de pagina
        footerWidth = "100%"
		# radio del pie de pagina
        rad = "0px"