gitbook
1.0.0
Docs - Comunidad - Documentos de desarrollador - ChangeLog - Informes de errores
Bienvenido a Gitbook, la plataforma para administrar el conocimiento técnico para los equipos.
Este repositorio contiene el código fuente abierto utilizado para representar el contenido publicado de Gitbook.
Empezando
Que contribuye
Tipos de contribuciones
Licencia
Expresiones de gratitud
Legacy Gitbook
Para ejecutar una versión local de este proyecto, siga estos simples pasos.
Node.js (versión:> = 18.x)
Bollo
Clonar el repositorio en un repositorio público de GitHub. Si planea distribuir el código, mantenga público el código fuente para cumplir con GNU GPLV3. Para clonar en un repositorio privado, adquiere una licencia comercial.
git clone https://github.com/gitbookIO/gitbook.git
Asegúrese de estar utilizando la versión del node del proyecto. Ejecutar nvm use cambiará su versión local a la correcta.
Instale las dependencias del proyecto a través de BUN.
bun install
Inicie su servidor de desarrollo local.
bun dev
Abra un espacio de GitBook publicado en su navegador web, prefijándolo con http://localhost:3000/ .
Ejemplos:
http: // localhost: 3000/docs.gitbook.com
http: // localhost: 3000/abre-source.gitbook.io/midJourney
Se puede acceder a cualquier sitio de Gitbook publicado a través de su instancia de desarrollo local, y cualquier actualización que realice a la base de código se reflejará en su navegador.
bun format : formatear el código
bun lint : pelusa el código
Todas las solicitudes de extracción se probarán con pruebas visuales y de rendimiento para evitar regresiones.
El motor de renderizado de Gitbook es de código abierto y está construido sobre Next.js. Dirígete a nuestra guía de contribución para obtener más información sobre el flujo de trabajo al agregar tu primera solicitud de extracción.
Le recomendamos que contribuya a Gitbook para ayudarnos a construir la mejor herramienta para documentar el conocimiento técnico. Si está buscando formas rápidas de contribuir, continúe leyendo para aprender más sobre las contribuciones populares.
La interfaz de usuario de Gitbook se representa utilizando un conjunto de archivos de traducción que se encuentran en packages/gitbook/src/intl/translations . Agradecemos todas las traducciones adicionales para la interfaz de usuario.
¿Encontrar un error o encontrar un problema que le gustaría solucionar? Ayudarnos a solucionar problemas relacionados con Gitbook mejora enormemente la experiencia para todos. Dirígete a la sección de problemas de este repositorio para obtener más información sobre los tipos de errores con los que ya puedes ayudar.
Advertencia
Si bien es posible autohacer este proyecto, no recomendamos esto a menos que esté segura de que esta opción se ajusta a sus necesidades.
¿Busca agregar una característica específica en Gitbook? Dirígete a nuestra guía contribuyente para comenzar.
Autohostante de este proyecto pone la responsabilidad de mantener y fusionar actualizaciones futuras sobre usted . No podemos garantizar el apoyo, el mantenimiento o las actualizaciones de las instancias bifurcadas y autohospedadas de este proyecto.
Queremos que sea lo más fácil posible para nuestra comunidad colaborar y impulsar el futuro de Gitbook, por lo que lo alentamos a que contribuya a nuestro producto directamente en lugar de crear su propia versión.
Este proyecto le permite autohacer la parte de representación de su contenido publicado por Gitbook. El autohospedaje tiene pros y contras.
En el lado profesional, puede personalizar la apariencia de su contenido, e incrustar mejor su documentación en su aplicación.
En el lado de la CON, se hace responsable de la confiabilidad de su sitio publicado y mantiene al renderizador actualizado con los cambios realizados en la plataforma Gitbook.
Distribuido bajo la licencia GNU GPLV3.
Si planea distribuir el código, debe hacer público el código fuente para cumplir con el GNU GPLV3. Para clonar en un repositorio privado, adquiere una licencia comercial.
Vea LICENSE para más información.
[! [Gitbook] (https://img.shields.io/static/v1?Message=Documented%20on%20gitbook&logo=gitbook&logoColor=fffffff&label=%20&labelcolor=5c5c5c&color=3f89a1)] (https://gitbook
<a href = "https://gitbook.com"> <imgsrc = "https://img.shields.io/static/v1?message=Documented%20on%20Gitbook&logo=gitbook&logoColor=fffffff&label=%20&labelor=5c5c5c5c5c&COY "
/> </a>Gitbook no sería posible sin estos proyectos:
Next.js
Bollo
CSS de viento de cola
Movimiento del marco
Nuestra versión anterior de Gitbook y su herramienta CLI ahora están en desuso. Todavía puede ver el antiguo repositorio y se compromete en esta rama.
