]> BookStack Code Mirror - bookstack/blob - resources/views/readme.md
Applied StyleCI changes, added php/larastan to attribution
[bookstack] / resources / views / readme.md
1 # BookStack Views
2
3 All views within this folder are [Laravel blade](https://laravel.com/docs/6.x/blade) views.
4
5 ### Overriding
6
7 Views can be overridden on a per-file basis via the visual theme system.
8 More information on this can be found within the `dev/docs/visual-theme-system.md`
9 file within this project.
10
11 ### Convention
12
13 Views are broken down into rough domain areas. These aren't too strict although many of the folders
14 here will often match up to a HTTP controller. 
15
16 Within each folder views will be structured like so:
17
18 ```txt
19 - folder/
20     - page-a.blade.php
21     - page-b.blade.php
22     - parts/
23         - partial-a.blade.php
24         - partial-b.blade.php
25     - subdomain/
26         - subdomain-page-a.blade.php
27         - subdomain-page-b.blade.php
28         - parts/
29             - subdomain-partial-a.blade.php
30             - subdomain-partial-b.blade.php
31 ```
32
33 If a folder contains no pages at all (For example: `attachments`, `form`) and only partials, then 
34 the partials can be within the top-level folder instead of pages to prevent unneeded nesting.
35
36 If a partial depends on another partial within the same directory, the naming of the child partials should be an extension of the parent.
37 For example:
38
39 ```txt
40 - tag-manager.blade.php
41 - tag-manager-list.blade.php
42 - tag-manager-input.blade.php
43 ```
Morty Proxy This is a proxified and sanitized view of the page, visit original site.