Enlaces externos
La lista links añade URL a la cabecera o a la barra lateral. Cada
entrada se renderiza como un enlace simple.
Uso básico
include: docs/**/*.html
links:
- title: GitHub
url: https://github.com/acme/docs
Campos
| Campo | Predeterminado | Uso |
|---|---|---|
url |
ninguno, obligatorio | La URL del enlace, absoluta o relativa a la raíz. |
title |
ninguno, obligatorio | Texto visible. |
position |
header |
Dónde se renderiza el enlace: header o sidebar.
|
prefix |
ninguno |
Muestra el enlace solo en las páginas bajo esta carpeta, como
/api/.
|
icon |
ninguno |
Un icono integrado antes del
título, como github; un nombre desconocido es un error.
|
Cualquier otro campo es un error. Una url relativa a la raíz recibe el
prefijo base como cualquier otra URL de la compilación.
Enlaces de la cabecera
Por defecto, los enlaces se renderizan en <htmlpress-links> en la
cabecera, entre el título del sitio y el selector de tema. Cuando no caben en la
cabecera, la búsqueda se reduce a su icono y luego los últimos enlaces se pliegan en
un menú Más, un icono en el móvil.
links:
- title: GitHub
url: https://github.com/acme/docs
- title: Docs
url: /introduction.html
Enlaces de la barra lateral
Define position: sidebar para renderizarlos dentro de la barra lateral
izquierda, al final de <htmlpress-nav>, debajo de las páginas.
links:
- title: Chat
url: https://discord.gg/example
position: sidebar
Para un enlace "Editar esta página" en cada página, usa edit en lugar
de un enlace: a su URL le sigue la ruta de origen de cada página, y el enlace se
renderiza en <htmlpress-edit> junto a la página.
edit: https://github.com/acme/docs/edit/main/
Limitar un enlace a una sección
Un prefix muestra un enlace solo en las páginas cuya URL empieza por
él, para un atajo por sección como "Informar de un problema". Igual que el prefijo
de una sección, empieza y termina con /.
links:
- title: Report an API issue
url: https://github.com/acme/api/issues
prefix: /api/
Ver también
- Secciones de artículos: las carpetas a las que apuntaría un enlace limitado.
- Metadatos del sitio: el título de la marca y el logo que se sitúan junto a los enlaces de la cabecera.
Hecho con ❤ y Htmlpress