跳转到主要内容

书籍

BookStack 文档（英文原版）

BookStack 的使用与管理指南（英文），从书架、书、章节、页面的编辑和组织讲起，也包括安装、升级、用户权限、备份等站点维护内容。适合 BookStack 的日常使用者和站点管理员。

2 章38 页更新于 20 小时前

开始阅读
MIT

目录38

  1. 第 1 章 用户文档 13 页
    1. 1.1 Attachments Within BookStack you can attach files & links to pages, so they can be referenced within content and shown ... 5 小时前
    2. 1.2 Content Overview The principles of storing information within BookStack is based of the ideas of a normal stack of books. Ju... 22 小时前
    3. 1.3 Content Tags While BookStack has a hierarchy at the center of the platform to organise content, you can sometimes desire... 5 小时前
    4. 1.4 Default Page Editor The default editor in BookStack is a 'What You See Is What You Get' (WYSIWYG) editor. The usage of this edi... 7 小时前
    5. 1.5 Drawings & Diagrams BookStack has built-in support for creating and editing drawings via integrating with diagrams.net. This in... 5 小时前
    6. 1.6 Getting Around and Finding Content There are many ways to get around and find content within your BookStack instance outside of following the ... 5 小时前
    7. 1.7 Markdown Editor If you prefer to write in a simpler format, a Markdown editor is available in BookStack. Markdown compatibi... 5 小时前
    8. 1.8 Organising Content Once your BookStack instance starts to grow you will find that you may want to re-organise your content. Wi... 5 小时前
    9. 1.9 Page Permalinks The URL for a page within BookStack includes a "Slug" generated based upon the name in addition to a "Slug"... 5 小时前
    10. 1.10 Page Templates Within BookStack you can mark a page as a template so that its content can easily be reused when editing an... 5 小时前
    11. 1.11 Reusing Page Content Within BookStack you may find that you want to include the same block of content in multiple places. You co... 5 小时前
    12. 1.12 Roles and Permissions Within BookStack the abilities of a user are controlled by the roles assigned to them and the permissions p... 5 小时前
    13. 1.13 Searching Content The ability to search your documentation is vital to day-to-day use. There are a few locations within BookS... 22 小时前
  2. 第 2 章 管理文档 25 页
    1. 2.1 Backup and Restore While BookStack does not currently have a built-in way to backup and restore content, it can usually be don... 7 小时前
    2. 2.2 BookStack System CLI The BookStack System CLI allows easy running of BookStack infrastructure-level tasks such as backing up, re... 7 小时前
    3. 2.3 Cache & Session Configuration Within BookStack specific data is cached server-side to increase performance in certain areas. Sessions are... 22 小时前
    4. 2.4 Commands BookStack has some command line actions that can help with maintenance and common operations. There are als... 5 小时前
    5. 2.5 Configuring File Uploads BookStack allows users to upload both images for content and files as attachments. For information relating... 5 小时前
    6. 2.6 Content Storage Format When building up a documentation store, or assessing platform options, it can be useful to understand how d... 5 小时前
    7. 2.7 Customising Visuals You may want to customise BookStack to use custom branding, or you may just not like the default blue theme... 7 小时前
    8. 2.8 Debugging Errors When using BookStack, especially when initially setting it up or after updating, you may come across some e... 7 小时前
    9. 2.9 Email & Webhooks Within BookStack email is used in various ways relating to user management & authentication. Outgoing webho... 7 小时前
    10. 2.10 Filesystem Permissions BookStack requires the ability to write and read files for various uses such as writing logs, handling file... 22 小时前
    11. 2.11 Hacking BookStack Sometimes you may want to perform deeper customisation to BookStack or extend the system to suit your use-c... 22 小时前
    12. 2.12 Installation Below you can find details on how to install BookStack on your own hosting. There are a number of installat... 7 小时前
    13. 2.13 Language Configuration By default the BookStack interface is shown in English. Additional languages are supported by the wider Boo... 22 小时前
    14. 2.14 LDAP Authentication BookStack can be configured to allow LDAP based user login. While LDAP login is enabled you cannot log in w... 22 小时前
    15. 2.15 Multiple BookStack Instances Currently BookStack does not support multiple instances from one installation but you can set up multiple i... 7 小时前
    16. 2.16 OpenID Connect Authentication OpenID Connect (OIDC) can be used within BookStack as a primary method of authentication. This replaces the... 7 小时前
    17. 2.17 Other Configuration .env Options Revision Limit Recycle Bin Lifetime Custom User Avatar Fetching Custom diagrams.net URL IP Add... 22 小时前
    18. 2.18 PDF Rendering By default BookStack uses dompdf to export pages as PDF documents. The benefit of using dompdf is that it d... 22 小时前
    19. 2.19 SAML 2.0 Authentication BookStack can be configured to utilise a SAML 2.0 based authentication provider as a solution for users to ... 22 小时前
    20. 2.20 Security Since BookStack can hold important information for users you should be aware of any potential security conc... 7 小时前
    21. 2.21 Subdirectory Setup You may want to host BookStack on a "Subdirectory" of your website, For example https://example.com/bookst... 7 小时前
    22. 2.22 Third Party Authentication BookStack currently supports login via a range of third party and social applications. Once enabled options... 7 小时前
    23. 2.23 Updating BookStack BookStack is updated regularly. We try our best to keep the platform and upgrade path as stable as possible... 7 小时前
    24. 2.24 Updating PHP & Composer While we try to ensure a fairly steady & stable path for BookStack updates, requirements do change as softw... 22 小时前
    25. 2.25 UTF8mb4/Emoji Support As of BookStack v0.17 UTF8mb4 is the default database charset and collation which allows emoji support. If... 22 小时前