Infra-Mirrors/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-10-01 01:36:00 -04:00
Code Issues Packages Projects Releases Wiki Activity
71a09bcf6e
BookStack/readme.md

13 KiB
Raw Blame History

BookStack

GitHub release license Crowdin Build Status Lint Status Maintainability

Repo Stats Discord Twitter YouTube

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

📚 Project Definition

BookStack is an opinionated wiki system 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 to the statement above.

In regard to development philosophy, BookStack has a relaxed, open & positive approach. At the end of the day this is free software developed and maintained by people donating their own free time.

🌟 Project Sponsors

Shown below are our bronze, silver and gold project sponsors. Big thanks to these companies for supporting the project. Note: Listed services are not tested, vetted nor supported by the official BookStack project in any manner. View all sponsors.

Silver Sponsors

Diagrams.net Cloudabove

Bronze Sponsors

Stellar Hosted Practicali Torutec

🛣️ Road Map

Below is a high-level road map view for BookStack to provide a sense of direction of where the project is going. This can change at any point and does not reflect many features and improvements that will also be included as part of the journey along this road map. For more granular detail of what will be included in upcoming releases you can review the project milestones as defined in our Release Process documentation.

  • Platform REST API - (Most actions implemented, maturing)
    • A REST API covering, at minimum, control of core content models (Books, Chapters, Pages) for automation and platform extension.
  • Permission System Review - (In Progress)
    • Improvement in how permissions are applied and a review of the efficiency of the permission & roles system.

🛠️ 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.

🌎 Translations

Translations for text within BookStack is managed through the BookStack project on Crowdin. Some strings have colon-prefixed variables such as :userName. Leave these values as they are as they will be replaced at run-time. Crowdin is the preferred way to provide translations, otherwise the raw translations files can be found within the resources/lang path.

If you'd like a new language to be added to Crowdin, for you to be able to provide translations for, please open a new issue here.

Please note, translations in BookStack are provided to the "Crowdin Global Translation Memory" which helps BookStack and other projects with finding translations. If you are not happy with contributing to this then providing translations to BookStack, even manually via GitHub, is not advised.

🎁 Contributing, Issues & Pull Requests

Feel free to create issues to request new features or to report bugs & problems. Just please follow the template given when creating the issue.

Pull requests are welcome. Unless a small tweak or language update, It may be best to open the pull request early or create an issue for your intended change to discuss how it will fit into the project and plan out the merge. Just because a feature request exists, or is tagged, does not mean that feature would be accepted into the core project.

Pull requests should be created from the development branch since they will be merged back into development once done. Please do not build from or request a merge into the release branch as this is only for publishing releases. If you are looking to alter CSS or JavaScript content please edit the source files found in resources/. Any CSS or JS files within public are built from these source files and therefore should not be edited directly.

The project's code of conduct can be found here.

🔒 Security

Security information for administering a BookStack instance can be found on the documentation site here.

If you'd like to be notified of new potential security concerns you can sign-up to the BookStack security mailing list.

If you would like to report a security concern, details of doing so can can be found here.

♿ Accessibility

We want BookStack to remain accessible to as many people as possible. We aim for at least WCAG 2.1 Level A standards where possible although we do not strictly test this upon each release. If you come across any accessibility issues please feel free to open an issue.

🖥️ Website, Docs & Blog

The website which contains the project docs & blog can be found in the BookStackApp/website repo.

⚖️ License

The BookStack source is provided under the MIT License.

The libraries used by, and included with, BookStack are provided under their own licenses and copyright. The licenses for many of our core dependencies can be found in the attribution list below but this is not an exhaustive list of all projects used within BookStack.

👪 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 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.