Personalizar el Footer en MkDocs Usando Overrides

En MkDocs, el tema por defecto no proporciona una opción directa para personalizar el footer desde el archivo de configuración. Sin embargo, puedes hacerlo mediante una carpeta de sobrescritura (overrides) que te permite modificar las plantillas HTML del tema. A continuación, te mostraré cómo puedes personalizar el footer de tu documentación paso a paso.

1. Preparar el Entorno

Crea un Directorio para Overrides

En el directorio raíz de tu proyecto MkDocs, crea una carpeta llamada overrides. Esta carpeta contendrá tus plantillas HTML personalizadas.

mkdir overrides

2. Crear una Plantilla Personalizada

Crear el Archivo de Plantilla

Dentro de la carpeta overrides, crea un archivo llamado main.html. Este archivo te permitirá modificar el HTML del tema por defecto de MkDocs.

touch overrides/main.html

Editar el Archivo main.html

Abre el archivo main.html con tu editor de texto y añade el siguiente código para sobrescribir el footer:

{% extends "base.html" %}

{% block footer %}
<footer>
  <div>
    <p>Tu texto personalizado en el footer</p>
    <p>© 2024</p>
  </div>
</footer>
{% endblock %}
  • {% extends "base.html" %}: Esto indica que estamos extendiendo la plantilla base del tema.
  • {% block footer %}: Aquí es donde personalizamos el contenido del footer. Puedes modificar el HTML según tus necesidades.

3. Configurar MkDocs para Usar Overrides

Modificar mkdocs.yml

Abre el archivo mkdocs.yml en el directorio raíz de tu proyecto. Añade la siguiente configuración para indicar que deseas usar la carpeta overrides:

theme:
  name: 'mkdocs'
  custom_dir: 'overrides'
  • custom_dir: 'overrides': Esto le dice a MkDocs que busque las plantillas personalizadas en la carpeta overrides.

4. Verificar los Cambios

Ejecutar el Servidor de Desarrollo

Para ver los cambios en tiempo real, ejecuta el servidor de desarrollo de MkDocs:

mkdocs serve

Abre tu navegador y ve a http://127.0.0.1:8000. Deberías ver el footer personalizado en tu sitio de documentación.

5. Construir el Sitio

Si todo está bien, puedes construir tu sitio para producción con:

mkdocs build

Esto generará los archivos estáticos en la carpeta site, que puedes desplegar en tu servidor.