1
0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-10-30 07:32:39 +01:00
BookStack/resources/views
julesdevops 99202b3bb8 fix(503): massively simplify the 503 error view
This view was relying on too much app logic, which could lead to errors
when rendering it.
2022-01-29 10:56:13 +01:00
..
api-docs Updated REST API docs with links to webhooks & theme-systems 2021-12-12 18:14:22 +00:00
attachments Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
auth Continued review of #2169 2021-10-06 23:05:26 +01:00
books Added copy considerations 2021-12-20 17:33:19 +00:00
chapters Added copy considerations 2021-12-20 17:33:19 +00:00
comments Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
common Further adjusted linked image sizes on PDF export 2022-01-24 17:24:00 +00:00
entities enh(recently updated): show updatedBy and updated_at 2022-01-19 21:49:45 +01:00
errors fix(503): massively simplify the 503 error view 2022-01-29 10:56:13 +01:00
form Added timeout and debugging statuses to webhooks 2022-01-03 19:42:48 +00:00
home Changed homepage card header links to be bottom-card-links 2021-11-23 18:18:49 +00:00
layouts Further adjusted linked image sizes on PDF export 2022-01-24 17:24:00 +00:00
mfa Update verify-totp.blade.php 2021-11-21 23:15:37 -05:00
misc Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
pages Improved loading for images with failed thumbnails 2022-01-10 18:13:48 +00:00
search Prevented created/update_by filters be wiped in search 2021-11-14 15:07:13 +00:00
settings Added timeout and debugging statuses to webhooks 2022-01-03 19:42:48 +00:00
shelves Added links to tag page 2021-11-06 20:21:11 +00:00
tags Added testing coverage for tag index 2021-11-06 21:54:02 +00:00
users Addressed user detail harvesting issue 2021-12-14 18:47:22 +00:00
vendor Revert "Added app logo to outgoing emails" 2021-05-26 17:13:59 +01:00
readme.md Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00

BookStack Views

All views within this folder are Laravel blade views.

Overriding

Views can be overridden on a per-file basis via the visual theme system. More information on this can be found within the dev/docs/visual-theme-system.md file within this project.

Convention

Views are broken down into rough domain areas. These aren't too strict although many of the folders here will often match up to a HTTP controller.

Within each folder views will be structured like so:

- folder/
    - page-a.blade.php
    - page-b.blade.php
    - parts/
        - partial-a.blade.php
        - partial-b.blade.php
    - subdomain/
        - subdomain-page-a.blade.php
        - subdomain-page-b.blade.php
        - parts/
            - subdomain-partial-a.blade.php
            - subdomain-partial-b.blade.php

If a folder contains no pages at all (For example: attachments, form) and only partials, then the partials can be within the top-level folder instead of pages to prevent unneeded nesting.

If a partial depends on another partial within the same directory, the naming of the child partials should be an extension of the parent. For example:

- tag-manager.blade.php
- tag-manager-list.blade.php
- tag-manager-input.blade.php