BookStack
v24.10.3
Платформа для хранения и организации информации и документации. Подробности о BookStack можно найти на официальном сайте https://www.bookstackapp.com/.
Инструкции по установке
Документация
Демо-экземпляр
Вход администратора
Скриншоты
Блог BookStack
Список проблем
Дискорд-чат
Варианты поддержки
BookStack — это продуманная платформа для документации, которая обеспечивает приятный и простой интерфейс. Новым пользователям экземпляра этот опыт должен показаться интуитивно понятным, и для участия в создании контента в BookStack потребуются только базовые навыки обработки текста. Платформа должна предоставлять расширенные мощные функции тем, кто этого желает, но они не должны мешать основному простому пользовательскому интерфейсу.
BookStack не задуман как расширяемая платформа, которую можно использовать для целей, отличных от приведенных выше.
Что касается философии развития, BookStack придерживается непринужденного, открытого и позитивного подхода. В конце концов, это бесплатное программное обеспечение, разработанное и поддерживаемое людьми, жертвующими свое свободное время.
Вы можете прочитать больше о проекте и его происхождении в нашем FAQ здесь.
Ниже показаны наши бронзовые, серебряные и золотые спонсоры проектов. Большое спасибо этим компаниям за поддержку проекта. Примечание. Перечисленные сервисы не тестируются, не проверяются и не поддерживаются официальным проектом BookStack каким-либо образом.
Подробности о пожертвовании проекта — Страница спонсоров GitHub — Страница Ko-fi
Пожалуйста, ознакомьтесь с нашей документацией по разработке для получения полной информации о работе над исходным кодом BookStack.
Если вы просто хотите настроить или расширить свой собственный экземпляр BookStack, загляните на нашу страницу документации «Взлом BookStack», чтобы узнать подробности о различных вариантах достижения этой цели без изменения исходного кода BookStack.
Подробности о схеме управления версиями BookStack и общем процессе выпуска можно найти здесь.
Переводы текста в BookStack управляются через проект BookStack на Crowdin. Некоторые строки имеют переменные с префиксом двоеточия, например :userName . Оставьте эти значения такими, какие они есть, поскольку они будут заменены во время выполнения.
Пожалуйста, используйте Crowdin для внесения переводов вместо открытия запроса на включение. Переводы в рабочей базе кода могут быть устаревшими, а слияние с помощью кода может вызвать конфликты и проблемы с синхронизацией. Если по какой-то причине вы не можете использовать Crowdin, не стесняйтесь открыть вопрос, чтобы обсудить альтернативные варианты.
Если вы хотите, чтобы в Crowdin был добавлен новый язык, чтобы вы могли предоставлять переводы, откройте новый выпуск здесь.
Обратите внимание, что переводы в BookStack передаются в «Глобальную память переводов Crowdin», которая помогает BookStack и другим проектам находить переводы. Если вас не устраивает участие в этом, не рекомендуется предоставлять переводы в BookStack, даже вручную через GitHub.
Не стесняйтесь создавать задачи, чтобы запрашивать новые функции или сообщать об ошибках и проблемах. Просто следуйте шаблону, указанному при создании проблемы.
Запросы на включение приветствуются, но, если это не небольшая настройка, возможно, лучше открыть запрос на включение заранее или создать задачу для предполагаемого изменения, чтобы обсудить, как оно впишется в проект, и спланировать слияние. Тот факт, что запрос на функцию существует или отмечен тегом, не означает, что эта функция будет принята в основной проект.
Запросы на включение следует создавать из ветки development , поскольку после завершения они будут снова объединены с development . Пожалуйста, не создавайте сборки и не запрашивайте слияние с веткой release , поскольку это предназначено только для публикации релизов. Если вы хотите изменить содержимое CSS или JavaScript, отредактируйте исходные файлы, находящиеся в resources/ . Любые файлы CSS или JS в public создаются на основе этих исходных файлов и поэтому не должны редактироваться напрямую.
Кодекс поведения проекта можно найти здесь.
Информацию о безопасности для администрирования экземпляра BookStack можно найти на сайте документации здесь.
Если вы хотите получать уведомления о новых потенциальных проблемах безопасности, вы можете подписаться на список рассылки по безопасности BookStack.
Если вы хотите сообщить о проблеме безопасности, подробную информацию об этом можно найти здесь.
Мы хотим, чтобы BookStack оставался доступным как можно большему количеству людей. Мы стремимся использовать как минимум стандарты WCAG 2.1 уровня A, где это возможно, хотя мы не проверяем их строго при каждом выпуске. Если у вас возникнут какие-либо проблемы с доступностью, пожалуйста, не стесняйтесь открыть проблему.
Веб-сайт, содержащий документацию и блог проекта, можно найти в репозитории BookStackApp/website.
Исходный код BookStack предоставляется по лицензии MIT.
Библиотеки, используемые и входящие в состав BookStack, предоставляются по их собственным лицензиям и авторским правам. Лицензии для многих наших основных зависимостей можно найти в списке авторства ниже, но это не исчерпывающий список всех проектов, используемых в BookStack.
Здесь можно увидеть замечательных людей, которые работали над созданием и улучшением BookStack. Замечательных людей, предоставивших переводы через GitHub или Crowdin, можно увидеть здесь.
Ниже приведены великолепные проекты с открытым исходным кодом, использованные для создания BookStack. Примечание. Это не исчерпывающий список всех библиотек и проектов, которые будут использоваться в активном экземпляре BookStack.
Ларавел — Массачусетский технологический институт
TinyMCE — Массачусетский технологический институт
Лексический - Массачусетский технологический институт
CodeMirror — Массачусетский технологический институт
Сортируемый - Массачусетский технологический институт
Значки материалов Google — Apache-2.0
списки задач markdown-it и markdown-it — MIT и ISC
Домpdf - LGPL v2.1
KnpLabs/snappy — Массачусетский технологический институт
WKHTMLtoPDF — LGPL v3.0
диаграммы.net – Условия встроенной версии/Исходный проект – Apache-2.0
Набор инструментов SAML PHP от OneLogin — MIT
Лига/CommonMark – пункт BSD-3
Лига/Flysystem — Массачусетский технологический институт
League/html-to-markdown — MIT
Лига/oauth2-клиент — MIT
pragmarx/google2fa — Массачусетский технологический институт
Код бекона/BaconQrCode — пункт BSD-2
phpseclib — Массачусетский технологический институт
Часовой механизм - Массачусетский технологический институт
PHPStan и Larastan — MIT и MIT
PHP_CodeSniffer — пункт 3 BSD
ДжейкАрчибальд/IDB-Keyval – Apache-2.0
Подробную информацию о проектах JavaScript и PHP, импортированных и используемых через менеджеры пакетов NPM и композитора, а также их лицензиях см. в файлах dev/licensing/js-library-licenses.txt и dev/licensing/php-library-licenses. txt-файлы.
