Iconos del índice
Puedes asignar un icono a cualquier elemento del índice de tu documentación, y tus lectores lo verán junto a esa entrada en la barra lateral de navegación. Los iconos funcionan bien como puntos de referencia para las pocas entradas que los lectores buscan más, como una guía de inicio rápido, un registro de cambios o un enlace a tu página de estado.
Añadir un icono
En el índice de la documentación, pasa el cursor sobre la entrada y haz clic en el icono de menú situado junto a ella.
Selecciona Add Icon . Si la entrada ya tiene uno, el elemento aparece como Change Icon.
Elige un icono y haz clic en Save.
Las páginas, las categorías, las etiquetas y los enlaces externos pueden llevar un icono. Los separadores no.
Establecer un icono está disponible para administradores y editores de publicación. Los redactores y los revisores no ven este elemento del menú.
Elegir un icono
El cuadro de diálogo ofrece dos fuentes, y una entrada usa solo una de ellas. Elegir del conjunto de iconos sustituye una imagen subida, y subir una imagen sustituye un icono elegido.
Font Awesome
Busca en el conjunto integrado en Choose an icon o recorre la cuadrícula de resultados. Las pestañas de la parte superior cambian entre los estilos Solid, Regular y Brands.
DeveloperHub carga Font Awesome 7 Free, que incluye 2157 iconos repartidos en esos tres estilos. Los estilos Pro (Light, Thin, Duotone y Sharp) no están incluidos. Para explorar visualmente el mismo conjunto antes de buscar, usa la búsqueda de Font Awesome con el filtro Free activado.
La búsqueda también reconoce los nombres antiguos de Font Awesome 5, así que al escribir times, cog o search se siguen encontrando xmark, gear y magnifying-glass.
Subir una imagen
Haz clic en Upload an image para usar tu propia imagen, que es la forma de poner el logotipo de un producto o de un socio en el índice. Usa un SVG o PNG cuadrado de al menos 32×32, ya que el icono se muestra a 15×15 junto al título de la entrada. Las imágenes subidas conservan sus propios colores y nunca se tiñen.
Quitar un icono
Abre el icono de menú junto a la entrada, selecciona Change Icon, haz clic en Remove y luego en Save.
Cómo afectan los iconos al índice
Los iconos están pensados para usarse con moderación, de modo que el índice siga siendo legible cuando solo unas pocas entradas llevan uno.
En cuanto una entrada tiene un icono, se reserva un espacio estrecho para él en todas las entradas de esa documentación, y los títulos quedan alineados en un mismo borde. Las entradas sin icono dejan el espacio vacío en lugar de mostrar un marcador de posición, lo que permite que destaquen los iconos que sí has establecido. Las categorías reservan su espacio por separado, por lo que añadir iconos a tus páginas no desplaza los encabezados de las categorías.
Si quitas el último icono de una documentación, el espacio desaparece y el índice vuelve a su diseño anterior.
Iconos en un repositorio sincronizado
En un proyecto sincronizado con GitHub, los iconos residen en el _nav.yaml de la documentación, no en el frontmatter de las páginas. La clave icon se coloca junto a la clave propia de la entrada:
Escribe el valor en una de estas formas:
Solid: el nombre del icono solo, como
rocket. No lleva el prefijofas:; solid es el estilo predeterminado.Regular: con el prefijo
far:, comofar:bell.Brands: con el prefijo
fab:, comofab:github.Una imagen: la URL
https://completa de la imagen. No se aceptan rutas relativas ni URL relativas al protocolo.
Normalmente, una página aparece en _nav.yaml como una ruta simple, por ejemplo - introduction. Solo se expande a la forma page: cuando lleva un icono, de modo que añadir esta función no reescribe la navegación de los repositorios que no usan iconos.
En una entrada de tipo enlace, ten en cuenta que icon es un elemento hermano de link, no uno de los campos que contiene.
Tu repositorio es la fuente de verdad de los iconos, igual que del resto de tu navegación. Eliminar una línea icon quita el icono de esa entrada en la siguiente sincronización.
Un nombre de icono que no existe en Font Awesome 7 Free, incluido un nombre exclusivo de Pro, se acepta igualmente. Se sincroniza sin ninguna advertencia y luego se muestra como un espacio vacío en el índice. Si un icono no aparece, comprueba primero el nombre en el conjunto Free.
Un valor que no es ni un nombre válido ni una URL de imagen, como una clase sin procesar del tipo fas fa-key, se notifica en la sincronización y se ignora.
La Agent Skill organize-docs-repo incluye la lista completa de nombres de iconos válidos, de modo que un agente que edite tu _nav.yaml elija nombres reales en lugar de adivinar.
Los iconos establecidos en una página se conservan al duplicar la página o clonar la versión.
Para colocar un icono dentro del cuerpo de una página en lugar de en el índice, consulta Iconos.
Need help? Visit our community forums or contact us.