Wikis

Cada repositorio puede alojar un wiki: una colección independiente de páginas en Markdown para documentación que vive junto al código sin mezclarse con él.

Habilitar el wiki

Abra el repositorio y seleccione Configuración.
En Características, active Wiki.
Aparece una pestaña Wiki en la navegación del repositorio.

Crear y editar páginas

Seleccione la pestaña Wiki.
Si el wiki aún no tiene páginas, seleccione Create the First Page. De lo contrario, seleccione New Page.
Escriba un título de página. El título se convierte en la URL de la página, así que elija algo claro y estable.
Escriba el contenido en Markdown y luego seleccione Save Page.

La primera página que cree se convierte en el Inicio del wiki: la página a la que llegan los visitantes de forma predeterminada. Para actualizar una página existente, ábrala y seleccione Editar. Cada vez que guarda se registra una nueva entrada en el historial de revisiones de la página.

Organizar el wiki

Dos páginas con nombres especiales controlan la navegación de todo el wiki:

_Sidebar — una barra lateral personalizada que se muestra en todas las páginas. Agregue aquí vínculos a sus páginas más importantes.
_Footer — un pie de página que se muestra al final de todas las páginas.

Cree cualquiera de ellas desde New Page con el nombre exacto indicado arriba. Para vincular páginas del wiki entre sí, use Markdown estándar y haga referencia al slug de la página:

See the [Setup Guide](setup-guide) for installation steps.

Use títulos de página descriptivos desde el principio: el título se convierte en la URL, y cambiar el nombre de una página más tarde rompe los vínculos existentes a ella.

Editar el wiki de forma local

El wiki es en sí mismo un repositorio de Git, disponible en la URL .wiki.git de su repositorio. Clónelo, edite los archivos Markdown en su editor y envíe los cambios de vuelta.

git clone https://git.example.plaidcloud.com/you/my-repo.wiki.git
cd my-repo.wiki
# edit or add .md files
git add .
git commit -m "Expand the setup guide"
git push

El mismo token de acceso personal que usa para el repositorio principal funciona aquí. Cada archivo Markdown se convierte en una página del wiki; el nombre del archivo (sin la extensión .md) es el slug de la página.