BookStackApp/BookStack

BookStack

A platform for storing and organising information and documentation. Details for BookStack can be found on the official website at https://www.bookstackapp.com/.

• Installation Instructions
• Documentation
• Demo Instance
• Screenshots
• BookStack Blog
• Issue List
• Community Discussions
• Support Options

👪 Attribution

The great people that have worked to build and improve BookStack can be seen here. The wonderful people that have provided translations, either through GitHub, Codeberg or via Crowdin can be seen here.

Below are the great open-source projects used to help build BookStack. Note: This is not an exhaustive list of all libraries and projects that would be used in an active BookStack instance.

For a detailed breakdown of the JavaScript & PHP projects imported and used via NPM & composer package managers, along with their licenses, please see the dev/licensing/js-library-licenses.txt and dev/licensing/php-library-licenses.txt files.

• Laravel - MIT
• TinyMCE - MIT
• Lexical - MIT
• CodeMirror - MIT
• Sortable - MIT
• Google Material Icons - Apache-2.0
• markdown-it and markdown-it-task-lists - MIT and ISC
• Dompdf - LGPL v2.1
• KnpLabs/snappy - MIT
• WKHTMLtoPDF - LGPL v3.0
• diagrams.net - Embedded Version Terms / Source Project - Apache-2.0
• SAML PHP Toolkit - MIT
• League/CommonMark - BSD-3-Clause
• League/Flysystem - MIT

📚 Project Definition

BookStack is an opinionated documentation platform that provides a pleasant and simple out-of-the-box experience. New users to an instance should find the experience intuitive and only basic word-processing skills should be required to get involved in creating content on BookStack. The platform should provide advanced power features to those that desire it, but they should not interfere with the core simple user experience.

BookStack is not designed as an extensible platform to be used for purposes that differ from the statement above.

In regard to development philosophy, BookStack has a relaxed, open & positive approach. We aim to slowly yet continuously evolve the platform while providing a stable & easy upgrade path.

You can read more about the project and its origins in our FAQ here.

🛠️ Development & Testing

Please see our development docs for full details regarding work on the BookStack source code.

If you're just looking to customize or extend your own BookStack instance, take a look at our Hacking BookStack documentation page for details on various options to achieve this without altering the BookStack source code.

Details about BookStack's versioning scheme and the general release process can be found here.