GitHUB Wiki

Para crear una wiki en GitHub como parte del repositorio, debes activar la función de documentación en tu repositorio y estructurar el contenido usando Markdown. [1, 2]

A continuación tienes los pasos exactos para lograrlo de forma rápida:

1. Activar la Wiki en tu repositorio

Si no ves la pestaña “Wiki” en la barra superior de tu repositorio, debes habilitarla: [1]

  1. Ve a la página principal de tu repositorio en GitHub.
  2. Haz clic en la pestaña Settings (Configuración) en el menú superior.
  3. En la sección General, baja hasta el apartado Features (Funciones).
  4. Marca la casilla Wikis. [1, 2]

2. Crear la página de inicio (Home)

  1. Regresa al menú superior de tu repositorio y haz clic en la nueva pestaña Wiki.
  2. Verás una pantalla de bienvenida. Haz clic en el botón verde Create the first page (Crear la primera página).
  3. El título predeterminado de esta página debe ser Home (obligatorio para que funcione como portada).
  4. Escribe una introducción para tu proyecto usando código Markdown de GitHub.
  5. Haz clic en Save page (Guardar página) al final del formulario. [1, 2, 3]

3. Crear páginas adicionales y subpáginas

Para estructurar un Trabajo de Fin de Grado (TFG) o cualquier proyecto complejo con secciones ordenadas: [1, 2]

  1. En la esquina superior derecha de la sección Wiki, haz clic en New Page.
  2. Dale un título descriptivo (por ejemplo: Instalación, Arquitectura o Manual de Uso).
  3. Añade el contenido correspondiente y haz clic en Save page. [1, 2]

4. Crear el menú lateral personalizado (_Sidebar)

Para tener un índice a la derecha igual al del ejemplo que compartes, necesitas un menú personalizado: [1]

  1. En la barra lateral de la derecha, haz clic en el botón + Add a custom sidebar (o crea una nueva página con el nombre exacto _Sidebar).
  2. En el editor, crea una lista de enlaces apuntando a las páginas que creaste en el paso anterior. El formato en Markdown es el siguiente:markdown### Navegación * [[Home]] * [[Instalación]] * [[Arquitectura]] * [[Manual de Uso]] Usa el código con precaución.
  3. Guarda la página. Este menú aparecerá automáticamente de forma estática en el lateral de todas tus secciones. [1, 2]

📌 Consejos profesionales para tu Wiki

  • Formato: Puedes usar texto en negrita, tablas, bloques de código e incluso añadir imágenes subiéndolas directamente al editor de GitHub. [1, 2, 3]
  • Control de versiones: Al igual que el código, cada cambio que guardas en la Wiki genera un commit. Puedes pulsar la pestaña History en cualquier página para ver cambios anteriores o revertir modificaciones accidentales. [1]
  • Clonar localmente: Al fondo de la Wiki encontrarás un enlace Git. Puedes clonar la wiki en tu ordenador (git clone ...) para redactar los archivos Markdown de forma local utilizando tu propio editor de texto (como VS Code) y luego subirlos con un git push. [1]

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *