GitBook es una plataforma que le permite a usted y a su equipo crear y colaborar en sitios de documentación. GitBook hace esto mediante el uso de conceptos de control de versiones, como bifurcación y fusión.
Dado que muchos miembros del equipo pueden trabajar en un solo sitio de documentación, GitBook le permite crear y administrar borradores separados. También puede ver las diferencias entre su borrador actual y la copia maestra de la documentación.
Hay varios tipos de bloques disponibles para agregar a sus páginas wiki. Esto incluye encabezados, párrafos, imágenes, sugerencias, tablas, bloques de código, archivos adjuntos y más.
Cómo agregar bloques de contenido en GitBook
Puede ver una lista de los bloques de contenido disponibles para agregar a una página. Puede hacer esto haciendo clic en cualquier parte de la página y haciendo clic en el más símbolo que aparece. También puede buscar directamente un bloque de contenido específico.
Puede agregar contenido usando Markdown. Si no ha usado Markdown antes, puede obtener más información sobre
cómo empezar con Markdown. También puede leer más sobre por qué Markdown es tan popular.Cómo agregar párrafos, listas, comillas o bloques de código
Para agregar listas, párrafos, citas, bloques de código u otros bloques de contenido simple, abra el menú desplegable y seleccione entre los tipos disponibles.
- En una página de su sitio de documentación, haga clic en el más en el lugar donde le gustaría agregar su contenido.
- Desde el menú desplegable, puede desplazarse por la lista para ver las diferentes opciones de contenido.
- Desde aquí, seleccione cualquier tipo de contenido simple, como un párrafo, un bloque de código, un encabezado o una cita. GitBook cambiará automáticamente el contenido para que coincida con el formato que ha seleccionado.
Cómo agregar imágenes o archivos adjuntos
Para agregar imágenes, use el menú desplegable para seleccionar el Imágenes opción de bloque de contenido. Para agregar archivos, seleccione el Insertar archivos opción en su lugar. Luego puede usar el panel de la derecha para administrar sus imágenes y archivos cargados.
- Abra una página en su sitio de documentación. Haga clic en el más para abrir el menú desplegable de bloques de contenido disponibles.
- Seleccione Insertar imágenes.
- En el panel de la derecha que aparece, hay tres pestañas. los archivos La pestaña le permite cargar su propio archivo de imagen. los URL La pestaña le permite vincular a una imagen en línea. También puede abrir el Unsplash pestaña. Aquí es donde puede seleccionar fotos existentes que no requieren atribución.
- Una vez que haya agregado una imagen, haga clic en el tres puntos botón ubicado en la esquina superior izquierda de la imagen. Esto abrirá un menú desplegable donde puede alinear la imagen o eliminarla. También puede poner un título a la imagen.
- Para insertar archivos, coloque el cursor en cualquier lugar de una página de su sitio de documentación. Haga clic en el más para abrir el menú desplegable de tipos de bloques de contenido. Esta vez, haga clic en el insertar archivos opción.
- Aparecerá un panel similar a la derecha, que le permitirá cargar cualquier archivo adjunto en lugar de una imagen. Haga clic en Búsqueda de archivos para seleccionar un archivo almacenado localmente en su computadora.
- El archivo aparecerá en la lista. Haga clic en el archivo y GitBook creará un bloque de contenido con el archivo adjunto en la página que tiene abierta. Al hacer clic en este bloque de contenido, se descargará el archivo adjunto.
Cómo agregar sugerencias
También puede agregar sugerencias a su página. Puede cambiar el ícono de las sugerencias para usar rojo para peligro, naranja para advertencia, azul para información o verde para éxito.
- Para agregar una pista, haga clic en el más para abrir el menú desplegable de bloques de contenido disponibles.
- Seleccione Insinuación.
- Esto agregará una pista a su página. De forma predeterminada, el tipo de pista es "información" y contiene un icono azul.
- Puede cambiar el tipo de pista haciendo clic en el icono. Esto recorrerá los cuatro tipos de pistas diferentes.
Cómo agregar tablas
Puede agregar tablas seleccionando el mesa opción de la lista desplegable. Una vez que tenga la tabla en la página, puede agregar nuevas filas o columnas. También puede modificar los nombres y tipos de datos de las columnas y cambiar los datos dentro de la tabla.
- Haga clic en el más para abrir el menú desplegable de bloques de contenido disponibles.
- Seleccione Mesa.
- Haga clic en el encabezado de una columna de la tabla. Esto abrirá un nuevo menú más pequeño, donde puede cambiar el nombre de la columna seleccionada. Este menú también le permite eliminar u ocultar la columna seleccionada. Para ciertos tipos de datos de columna, también puede alinear el contenido dentro de la columna.
- De forma predeterminada, el tipo de datos seleccionado para las columnas es "Texto". Haga clic en el botón con el T símbolo para cambiar el tipo de datos. Puede cambiarlo a un número, casilla de verificación, menú desplegable, archivo adjunto, calificación o más.
- Haga clic en el icono de seis puntos cerca de la esquina superior izquierda de la tabla. Aquí puede insertar nuevas columnas y filas o eliminar toda la tabla. También puede ocultar o mostrar ciertas columnas, o cambiar otras propiedades de la tabla.
Cómo agregar bloques de enlaces de página
Los bloques de enlaces de página son enlaces que ocupan toda la línea de la página. Cuando agrega el enlace, debe vincular a la página que se abrirá cuando alguien haga clic en ella.
- Haga clic en el más para abrir el menú desplegable de bloques de contenido disponibles.
- Haga clic en Enlace de página.
- En el nuevo menú desplegable, elija la página a la que está enlazando.
- El enlace de su página aparecerá dentro de un bloque en la página.
Uso de GitBook para la documentación
GitBook es una herramienta de documentación que utiliza conceptos de control de versiones como bifurcación y fusión. Esto permite que más de un miembro del equipo trabaje simultáneamente en la documentación. También ayuda a gestionar los conflictos que se produzcan.
Puede agregar todo tipo de bloques de contenido a una página. Puede usar encabezados, párrafos, bloques de código o viñetas para reformatear su contenido. Puede cambiar el tipo de sugerencia, el mensaje y el tipo de icono de las sugerencias, así como personalizar las columnas de una tabla.
La pestaña Archivos le permite administrar imágenes y archivos adjuntos que cargue en el sitio. Los enlaces de página le permiten crear enlaces grandes que los usuarios pueden detectar fácilmente.
Si está creando documentación relacionada con el lenguaje Go, puede usar Godoc. Godoc le permite documentar automáticamente su código Go.
