Cada repositorio de GitHub viene equipado con una sección para hospedar documentación, denominada wiki. Puedes usar la wiki de tu repositorio para compartir contenido en forma completa acerca de tu proyecto, como por ejemplo cómo usarlo, cómo lo diseñaste o sus principios básicos. Un archivo README rápidamente dice lo que puede hacer tu proyecto, mientras que puedes usar una wiki para proporcionar documentación adicional. Para más información, consulta Acerca de los archivos README.
Con las wikis, puede escribir contenido como en cualquier otro lado en GitHub. Para más información, consulta Introducción a la escritura y la aplicación de formato en GitHub. Usamos nuestra biblioteca de marcado de código abierto para convertir diferentes formatos en HTML, por lo que puede optar por escribir en Markdown o en cualquier otro formato admitido.
Puede usar Markdown para agregar expresiones matemáticas representadas, diagramas, mapas y modelos 3D a la wiki. Para más información sobre cómo crear expresiones matemáticas representadas, consulta "Escritura de expresiones matemáticas". Para más información sobre cómo crear diagramas, mapas y modelos 3D, consulta "Crear diagramas".
Si creas una wiki en un repositorio público, estará disponible para el público. Si creas una wiki en un repositorio privado, solo los usuarios que tengan acceso al repositorio podrán acceder a la wiki. Para más información, consulta Configurar la visibilidad de un repositorio.
Puedes editar las wikis directamente en GitHub o puedes editar los archivos wiki localmente. De manera predeterminada, solo los usuarios con acceso de escritura a tu repositorio pueden hacer cambios en las wikis, aunque puedes permitir que cualquier usuario de GitHub.com colabore con una wiki en un repositorio público. Para más información, consulta Cambiar permisos de acceso para wikis.
Note
Los motores de búsqueda solo indexan wikis con 500 o más estrellas que configures para evitar la edición pública. Para más información, consulta Cambiar permisos de acceso para wikis.
Si necesitas que los motores de búsqueda indexen el contenido, puedes usar GitHub Pages en un repositorio público. Para más información, consulta GitHub Pages.
Note
Por motivos de rendimiento, las wikis tienen un límite temporal de 5000 archivos totales, independientemente del tipo de archivo. Si supera este límite, es posible que algunas páginas no sean accesibles para los usuarios. Si necesita una wiki más grande, se recomienda utilizar GitHub Pages. Para más información, consulta GitHub Pages.