Hudocs se configura mediante el archivo principal de configuración de tu sitio. Esta página describe las opciones disponibles para configurar el tema.

Ajustes principales #

baseURL #

URL base del sitio de documentación en producción.

baseURL = 'https://ejemplo.com/'

enableRobotsTXT #

Cuando se establece en true, Hugo genera un archivo robots.txt para el sitio.

enableRobotsTXT = true

enableInlineShortcodes #

Cuando se establece en true, Hugo permite declarar shortcodes en línea (inline shortcodes) directamente dentro de los archivos Markdown de contenido.

enableInlineShortcodes = true

enableGitInfo #

Cuando se establece en true, Hugo obtiene información del repositorio Git para proporcionar datos sobre el último commit, como la fecha de modificación de una página.

enableGitInfo = true

disableKinds #

Desactiva tipos de contenido que no son necesarios para un sitio de documentación. Esto evita que Hugo genere páginas de taxonomías, términos y feeds RSS.

disableKinds = ["taxonomy", "term", "RSS"]

Internacionalización #

Para habilitar varios idiomas, define los idiomas disponibles en la sección [languages]. Cada idioma requiere un identificador, una etiqueta y un peso que determina el orden.

[languages.en]
  label = "English"
  weight = 1

[languages.es]
  label = "Español"
  weight = 2

Renderizado y Markdown #

Las opciones de Markdown y resaltado de sintaxis se configuran mediante la sección [markup].

HTML dentro de Markdown #

Permite procesar HTML incluido directamente en los archivos Markdown. Esta opción es necesaria para los shortcodes y componentes que utilizan HTML.

[markup.goldmark.renderer]
  unsafe = true

Resaltado de sintaxis #

Configura Chroma para generar clases CSS en los bloques de código en lugar de estilos en línea. Esto permite que Hudocs controle los estilos de los bloques de código según el tema visual activo.

[markup.highlight]
  noClasses = false

Tabla de contenidos #

Define los niveles de encabezado que se incluyen en la tabla de contenidos. Con esta configuración se incluyen los encabezados <h2> y <h3>.

[markup.tableOfContents]
  startLevel = 2
  endLevel = 3

Parámetros del tema #

Las opciones específicas de Hudocs se configuran dentro de [params]. Las opciones se organizan por su alcance funcional:

Sitio #

description #

Descripción global utilizada para metadatos SEO, tarjetas Open Graph, Twitter cards y la página principal.

description = "A Hugo theme for documentation sites"

image_first_eager #

Cuando se establece en true, la primera imagen de la página se carga de forma anticipada con loading="eager" y fetchpriority="high". El valor predeterminado es true.

image_first_eager = true

Identidad de Marca (Branding) #

brand_icon #

Nombre de un ícono del catálogo de Meteor Icons que se muestra junto al título del sitio en la cabecera. El valor predeterminado es "book-open".

brand_icon = "book-open"

Ruta a una imagen utilizada como logotipo. Cuando se define, reemplaza el ícono configurado mediante brand_icon y el título del sitio.

brand_logo = "images/logo.svg"

Documentación #

docs_section #

Nombre de la sección raíz de documentación. El valor por defecto es "docs".

docs_section = "docs"

docs_versions #

Lista explícita y orden de las versiones para el selector. Si se omite, Hudocs detecta automáticamente las versiones desde content/docs/. Establecer en false para modo monoversión.

docs_versions = ["latest", "1.8", "1.0"]

docs_expand_tree #

Expande todas las secciones en el árbol de navegación de la barra lateral de documentación. Si se establece en false, solo la sección activa se expande automáticamente. El valor predeterminado es false.

docs_expand_tree = false

docs_pagination #

Controla la navegación entre páginas de documentación mediante los enlaces “Anterior” y “Siguiente” al final del contenido. El valor predeterminado es true.

docs_pagination = true

docs_edit_url #

Añade un enlace de edición a la cabecera de cada artículo de documentación. El enlace utiliza el ícono pencil y dirige al archivo correspondiente en tu repositorio Git.

docs_edit_url = "https://github.com/tu-usuario/repositorio/tree/main/content"

docs_badge_text #

Texto predeterminado que se muestra en las insignias de documentación habilitadas en las páginas. Si se omite, toma por defecto la traducción correspondiente de "new" (i18n "new").

docs_badge_text = "Nuevo"

docs_badge_url #

URL de destino para las insignias de documentación configuradas globalmente.

docs_badge_url = "https://ejemplo.com"

docs_ai #

Controla el botón de acción con Asistente de IA en el encabezado de los artículos de documentación. Si se establece en false, el menú desplegable de IA se oculta. El valor predeterminado es true.

docs_ai = true

docs_chatgpt #

Controla la acción “Abrir en ChatGPT” dentro del menú desplegable del Asistente de IA. El valor predeterminado es true.

docs_chatgpt = true

docs_claude #

Controla la acción “Abrir en Claude” dentro del menú desplegable del Asistente de IA. El valor predeterminado es true.

docs_claude = true

Bloques de Código #

code_theme #

Configura el tema de color para los bloques de código con resaltado de sintaxis. Los temas disponibles son duotone-dark, duotone-dark-sky, duotone-dark-sea, duotone-dark-space, duotone-dark-earth y duotone-dark-forest. El valor predeterminado es duotone-dark.

code_theme = "duotone-dark"

Publicaciones (Blog) #

posts_paginate #

Define la cantidad de publicaciones mostradas por página en el listado de blog. El valor predeterminado es 10.

posts_paginate = 10

posts_date_format #

Define el formato utilizado para las fechas de publicación en las tarjetas de artículos. El formato sigue las reglas de fecha de Go. El valor predeterminado es 2006-01-02.

posts_date_format = "January 2, 2006"

Define el formato utilizado para mostrar la fecha de actualización de las páginas en el pie. El formato utiliza las reglas de fecha de Go. El valor predeterminado es 2006-01-02.

footer_date_format = "2006-01-02"

Define el texto de copyright que muestra el pie del sitio. El valor admite Markdown. Se puede utilizar {{Year}} para insertar automáticamente el año actual.

footer_copyright = "Created by [@zkreations](https://zkreations.com)"