Una plataforma para almacenar y organizar información y documentación. Los detalles de BookStack se pueden encontrar en el sitio web oficial en https://www.bookstackapp.com/.
Instrucciones de instalación
Documentación
Instancia de demostración
Inicio de sesión de administrador
Capturas de pantalla
Blog de pila de libros
Lista de problemas
Chat de discordia
Opciones de soporte
BookStack es una plataforma de documentación obstinada que proporciona una experiencia agradable y sencilla lista para usar. Los nuevos usuarios de una instancia deberían encontrar la experiencia intuitiva y solo se deberían requerir habilidades básicas de procesamiento de textos para participar en la creación de contenido en BookStack. La plataforma debe proporcionar funciones potentes avanzadas a quienes las deseen, pero no deben interferir con la experiencia básica del usuario.
BookStack no está diseñado como una plataforma extensible para ser utilizada con fines distintos a los mencionados anteriormente.
En cuanto a la filosofía de desarrollo, BookStack tiene un enfoque relajado, abierto y positivo. Al fin y al cabo, se trata de software gratuito desarrollado y mantenido por personas que donan su propio tiempo libre.
Puede leer más sobre el proyecto y sus orígenes en nuestras preguntas frecuentes aquí.
A continuación se muestran nuestros patrocinadores de proyectos de bronce, plata y oro. Muchas gracias a estas empresas por apoyar el proyecto. Nota: Los servicios enumerados no son probados, examinados ni respaldados por el proyecto oficial BookStack de ninguna manera.
Detalles de la donación del proyecto - Página de patrocinadores de GitHub - Página de Ko-fi
Consulte nuestros documentos de desarrollo para obtener detalles completos sobre el trabajo en el código fuente de BookStack.
Si solo está buscando personalizar o ampliar su propia instancia de BookStack, eche un vistazo a nuestra página de documentación Hacking BookStack para obtener detalles sobre varias opciones para lograr esto sin alterar el código fuente de BookStack.
Los detalles sobre el esquema de control de versiones de BookStack y el proceso de lanzamiento general se pueden encontrar aquí.
Las traducciones de texto dentro de BookStack se gestionan a través del proyecto BookStack en Crowdin. Algunas cadenas tienen variables con prefijo de dos puntos, como :userName
. Deje estos valores como están, ya que serán reemplazados en tiempo de ejecución.
Utilice Crowdin para contribuir con traducciones en lugar de abrir una solicitud de extracción. Las traducciones dentro del código base de trabajo pueden estar desactualizadas y la fusión mediante código puede causar conflictos y problemas de sincronización. Si por alguna razón no puedes usar Crowdin, no dudes en abrir un problema para discutir opciones alternativas.
Si desea agregar un nuevo idioma a Crowdin, para poder proporcionar traducciones, abra una nueva edición aquí.
Tenga en cuenta que las traducciones en BookStack se proporcionan a la "Memoria de traducción global de Crowdin", que ayuda a BookStack y a otros proyectos a encontrar traducciones. Si no está satisfecho con contribuir a esto, no se recomienda proporcionar traducciones a BookStack, ni siquiera manualmente a través de GitHub.
No dudes en crear problemas para solicitar nuevas funciones o informar errores y problemas. Simplemente siga la plantilla proporcionada al crear el problema.
Las solicitudes de extracción son bienvenidas pero, a menos que se trate de un pequeño ajuste, puede ser mejor abrir la solicitud de extracción con anticipación o crear un problema para el cambio previsto para analizar cómo encajará en el proyecto y planificar la fusión. El hecho de que exista una solicitud de función, o esté etiquetada, no significa que esa función sea aceptada en el proyecto principal.
Las solicitudes de extracción deben crearse desde la rama development
, ya que se fusionarán nuevamente con development
una vez realizadas. No cree ni solicite una fusión en la rama release
, ya que esto es solo para lanzamientos de publicación. Si desea modificar el contenido de CSS o JavaScript, edite los archivos fuente que se encuentran en resources/
. Todos los archivos CSS o JS public
se crean a partir de estos archivos fuente y, por lo tanto, no deben editarse directamente.
El código de conducta del proyecto se puede encontrar aquí.
La información de seguridad para administrar una instancia de BookStack se puede encontrar en el sitio de documentación aquí.
Si desea recibir notificaciones sobre nuevos problemas de seguridad potenciales, puede suscribirse a la lista de correo de seguridad de BookStack.
Si desea informar un problema de seguridad, puede encontrar los detalles para hacerlo aquí.
Queremos que BookStack siga siendo accesible para la mayor cantidad de personas posible. Nuestro objetivo es alcanzar al menos los estándares WCAG 2.1 Nivel A siempre que sea posible, aunque no los probamos estrictamente en cada versión. Si encuentra algún problema de accesibilidad, no dude en abrir un problema.
El sitio web que contiene los documentos y el blog del proyecto se puede encontrar en el repositorio BookStackApp/sitio web.
La fuente de BookStack se proporciona bajo la licencia MIT.
Las bibliotecas utilizadas por BookStack y incluidas en él se proporcionan bajo sus propias licencias y derechos de autor. Las licencias para muchas de nuestras dependencias principales se pueden encontrar en la lista de atribuciones a continuación, pero esta no es una lista exhaustiva de todos los proyectos utilizados en BookStack.
Aquí se puede ver a las grandes personas que han trabajado para construir y mejorar BookStack. Las personas maravillosas que han proporcionado traducciones, ya sea a través de GitHub o Crowdin, se pueden ver aquí.
A continuación se muestran los excelentes proyectos de código abierto utilizados para ayudar a construir BookStack. Nota: Esta no es una lista exhaustiva de todas las bibliotecas y proyectos que se usarían en una instancia activa de BookStack.
Laravel- MIT
TinyMCE - MIT
Léxico - MIT
CodeMirror- MIT
Ordenable - MIT
Iconos de materiales de Google - Apache-2.0
markdown-it y markdown-it-task-lists - MIT e ISC
Dompdf- LGPL v2.1
KnpLabs/snappy - MIT
WKHTMLtoPDF - LGPL v3.0
diagramas.net - Términos de la versión integrada/Proyecto fuente - Apache-2.0
Kit de herramientas PHP SAML de OneLogin - MIT
Liga/CommonMark - Cláusula BSD-3
Liga/Flysystem - MIT
Liga/html-to-markdown - MIT
Liga/cliente oauth2 - MIT
pragmarx/google2fa - MIT
Bacon/BaconQrCode - Cláusula BSD-2
phpseclib- MIT
Mecanismo de relojería - MIT
PHPStan & Larastan - MIT y MIT
PHP_CodeSniffer - BSD 3 cláusulas
JakeArchibald/BID-Keyval - Apache-2.0
Para obtener un desglose detallado de los proyectos de JavaScript y PHP importados y utilizados a través de los administradores de paquetes NPM y Composer, junto con sus licencias, consulte dev/licensing/js-library-licenses.txt y dev/licensing/php-library-licenses. archivos de texto.