Logo e iconos¶
Material for MkDocs se suministra con más de 8000 íconos listos para usarse de dos formas:
- para personalizar partes específicas del tema
- para incluirlos como parte del texto Markdown
Cambiar el logo¶
Por defecto, el logo que aparece en la cabecera es . Para usar uno de los iconos incluidos, podemos configurarlo de la siguiente forma:
theme:
icon:
logo: material/library
Lo que mostrará . Si por ejemplo escribimos:
theme:
icon:
logo: octicons/pencil-24
Mostrará como logo.
Podemos buscar iconos en la documentación, donde hay una búsqueda interactiva.
Para usar un fichero de imagen, escribimos:
theme:
logo: objetos/logo.png
siendo objetos una carpeta dentro de docs.
Enlace¶
Al pulsar en el logo de cabecera, típicamente enlazamos con la página principal del proyecto. Podemos especificar otra url si en mkdocs.yml incluimos:
extra:
homepage: https://ejemplo.com
Favicon¶
El favicon es el icono que aparece en la pestaña del navegador. Podemos usar un fichero de imagen dentro de una carpeta en el directorio docs:
theme:
favicon: objetos/favicon.png
Resto de iconos del sitio¶
Los iconos de navegación, búsqueda, etc, pueden cambiarse por otros. Por ejemplo, las flechas página siguiente/anterior que aparecen al pie de página:
theme:
icon:
previous: fontawesome/solid/angle-left
next: fontawesome/solid/angle-right
Los siguientes están disponibles:
| Icono | Propósito |
|---|---|
| logo | Logo de la cabecera |
| menu | Abre el menú |
| alternate | Cambiar idioma |
| search | Abrir búsqueda |
| share | Compartir |
| close | Descartar búsqueda |
| top | Inicio del documento |
| edit | Editar página |
| view | Ver texto fuente |
| repo | Repositorio |
| admonition | Iconos de notas. Ver extensión Admonition |
| tag | Ver extensión Tags |
| previous | Página anterior |
| next | Siguiente página |