BookStack
v24.10.3
Uma plataforma para armazenar e organizar informações e documentação. Detalhes do BookStack podem ser encontrados no site oficial em https://www.bookstackapp.com/.
Instruções de instalação
Documentação
Instância de demonstração
Login de administrador
Capturas de tela
Blog da pilha de livros
Lista de problemas
Bate-papo de discórdia
Opções de suporte
BookStack é uma plataforma de documentação opinativa que oferece uma experiência agradável, simples e pronta para uso. Os novos usuários de uma instância devem achar a experiência intuitiva e apenas habilidades básicas de processamento de texto devem ser necessárias para se envolver na criação de conteúdo no BookStack. A plataforma deve fornecer recursos avançados de energia para aqueles que os desejam, mas não devem interferir na experiência simples do usuário.
BookStack não foi projetado como uma plataforma extensível para ser usada para propósitos diferentes da afirmação acima.
No que diz respeito à filosofia de desenvolvimento, BookStack tem uma abordagem descontraída, aberta e positiva. No final das contas, este é um software livre desenvolvido e mantido por pessoas que doam seu próprio tempo livre.
Você pode ler mais sobre o projeto e suas origens em nosso FAQ aqui.
Abaixo estão nossos patrocinadores de projetos bronze, prata e ouro. Muito obrigado a essas empresas por apoiarem o projeto. Nota: Os serviços listados não são testados, avaliados nem suportados pelo projeto oficial BookStack de forma alguma.
Detalhes da doação do projeto - Página de patrocinadores do GitHub - Página Ko-fi
Consulte nossos documentos de desenvolvimento para obter detalhes completos sobre o trabalho no código-fonte do BookStack.
Se você deseja apenas personalizar ou estender sua própria instância do BookStack, dê uma olhada em nossa página de documentação Hacking BookStack para obter detalhes sobre várias opções para conseguir isso sem alterar o código-fonte do BookStack.
Detalhes sobre o esquema de versionamento do BookStack e o processo geral de lançamento podem ser encontrados aqui.
As traduções de texto no BookStack são gerenciadas através do projeto BookStack no Crowdin. Algumas strings têm variáveis prefixadas com dois pontos, como :userName . Deixe esses valores como estão, pois eles serão substituídos em tempo de execução.
Use o Crowdin para contribuir com traduções em vez de abrir uma solicitação pull. As traduções dentro da base de código funcional podem estar desatualizadas e a fusão por meio de código pode causar conflitos e problemas de sincronização. Se por algum motivo você não puder usar o Crowdin, sinta-se à vontade para abrir uma edição para discutir opções alternativas.
Se desejar que um novo idioma seja adicionado ao Crowdin, para que você possa fornecer traduções, abra uma nova edição aqui.
Observe que as traduções no BookStack são fornecidas para o "Crowdin Global Translation Memory", que ajuda o BookStack e outros projetos a encontrar traduções. Se você não estiver satisfeito em contribuir para isso, não é aconselhável fornecer traduções para o BookStack, mesmo manualmente via GitHub.
Sinta-se à vontade para criar problemas para solicitar novos recursos ou relatar bugs e problemas. Apenas siga o modelo fornecido ao criar o problema.
Solicitações pull são bem-vindas, mas, a menos que seja um pequeno ajuste, talvez seja melhor abrir a solicitação pull antecipadamente ou criar um problema para a mudança pretendida para discutir como ela se encaixará no projeto e planejar a mesclagem. Só porque existe uma solicitação de recurso ou está marcada, não significa que esse recurso seria aceito no projeto principal.
As solicitações pull devem ser criadas a partir do branch development , pois serão mescladas novamente no development quando concluídas. Por favor, não crie ou solicite uma fusão no branch release , pois isso é apenas para publicação de lançamentos. Se você deseja alterar o conteúdo CSS ou JavaScript, edite os arquivos de origem encontrados em resources/ . Quaisquer arquivos CSS ou JS public são criados a partir desses arquivos de origem e, portanto, não devem ser editados diretamente.
O código de conduta do projeto pode ser encontrado aqui.
Informações de segurança para administrar uma instância BookStack podem ser encontradas no site de documentação aqui.
Se quiser ser notificado sobre novas possíveis preocupações de segurança, você pode se inscrever na lista de discussão de segurança do BookStack.
Se você quiser relatar uma preocupação de segurança, detalhes sobre como fazê-lo podem ser encontrados aqui.
Queremos que o BookStack permaneça acessível ao maior número de pessoas possível. Nosso objetivo é pelo menos os padrões WCAG 2.1 Nível A sempre que possível, embora não testemos isso estritamente em cada versão. Se você encontrar algum problema de acessibilidade, sinta-se à vontade para abrir um problema.
O site que contém os documentos e o blog do projeto pode ser encontrado no repositório BookStackApp/website.
A fonte BookStack é fornecida sob a licença MIT.
As bibliotecas usadas e incluídas no BookStack são fornecidas sob suas próprias licenças e direitos autorais. As licenças para muitas de nossas dependências principais podem ser encontradas na lista de atribuições abaixo, mas esta não é uma lista exaustiva de todos os projetos usados no BookStack.
As grandes pessoas que trabalharam para construir e melhorar o BookStack podem ser vistas aqui. As pessoas maravilhosas que forneceram traduções, seja através do GitHub ou do Crowdin, podem ser vistas aqui.
Abaixo estão os excelentes projetos de código aberto usados para ajudar a construir o BookStack. Nota: Esta não é uma lista exaustiva de todas as bibliotecas e projetos que seriam usados em uma instância ativa do BookStack.
Laravel- MIT
TinyMCE- MIT
Léxico - MIT
CodeMirror- MIT
Classificável - MIT
Ícones de materiais do Google - Apache-2.0
listas de tarefas markdown-it e markdown-it - MIT e ISC
Dompdf - LGPL v2.1
KnpLabs/snappy - MIT
WKHTMLtoPDF - LGPL v3.0
diagrams.net - Termos da versão incorporada/Projeto fonte - Apache-2.0
Kit de ferramentas SAML PHP do OneLogin - MIT
League/CommonMark - Cláusula BSD-3
Liga/Flysystem - MIT
Liga/html para marcação - MIT
Liga/cliente oauth2 - MIT
pragmarx/google2fa - MIT
Bacon/BaconQrCode - Cláusula BSD-2
phpseclib- MIT
Mecanismo de Relógio - MIT
PHPStan e Larastan - MIT e MIT
PHP_CodeSniffer - Cláusula 3 do BSD
JakeArchibald/IDB-Keyval - Apache-2.0
Para uma análise detalhada dos projetos JavaScript e PHP importados e usados por meio de gerenciadores de pacotes NPM e compositor, junto com suas licenças, consulte dev/licensing/js-library-licenses.txt e dev/licensing/php-library-licenses. arquivos txt.
