1
0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-10-30 07:32:39 +01:00
BookStack/resources/views
2022-11-20 22:20:31 +00:00
..
api-docs Added api format advisory regarding PUT/DELETE form data 2022-09-28 20:15:48 +01:00
attachments Updated attachment links to have dropdown for open type 2022-05-19 17:38:04 +01:00
auth Updated email confirmation flow so confirmation is done via POST 2022-11-12 15:11:59 +00:00
books Distributed shortcut actions to common ui elements 2022-11-05 13:39:17 +00:00
chapters Distributed shortcut actions to common ui elements 2022-11-05 13:39:17 +00:00
comments Standardised dropdown list item styles, Extracted page editor toolbar 2022-04-20 14:03:47 +01:00
common Added global search input debounce and loading indicator 2022-11-20 22:20:31 +00:00
entities Aligned user preference endpoints in style and behaviour 2022-11-09 19:30:08 +00:00
errors Added help/about box to wysiwyg editor 2022-02-07 23:19:04 +00:00
exports Reorganised and split out export templates & styles 2022-06-08 17:56:59 +01:00
form Extracted hardcoded english text to language files 2022-11-10 13:30:48 +00:00
help Added ordered/unordered WYSIWYG list shortcuts 2022-07-26 16:43:15 +01:00
home Aligned user preference endpoints in style and behaviour 2022-11-09 19:30:08 +00:00
layouts Started interface user shortcut form interface 2022-11-08 21:17:45 +00:00
mfa Standardised dropdown list item styles, Extracted page editor toolbar 2022-04-20 14:03:47 +01:00
misc Reorgranised blade view files to form a convention 2021-08-22 13:17:32 +01:00
pages Added swift support to code blocks and editor 2022-11-12 08:44:25 +00:00
search Updated search term lists to flex layouts 2022-11-03 12:49:05 +00:00
settings Fixed use of array unpacking syntax 2022-11-03 14:33:23 +00:00
shelves Aligned user preference endpoints in style and behaviour 2022-11-09 19:30:08 +00:00
tags Updated tags list to new responsive format 2022-10-31 11:40:28 +00:00
users Extracted shortcut text to language files 2022-11-10 10:25:28 +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